Skip to content
This repository was archived by the owner on Mar 2, 2022. It is now read-only.

Commit 1e0ce20

Browse files
authored
Create README.md
1 parent 59134d2 commit 1e0ce20

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Wikia
2+
=========
3+
4+
**Wikia** is a Python library that makes it easy to access and parse
5+
data from any `wikia website <https://www.wikia.com>`
6+
7+
Search a wikia, get article summaries, get data like links and images
8+
from a page, and more. Wikipedia wraps the `Wikia API
9+
<http://api.wikia.com/wiki/Wikia_API_Wiki>`__ so you can focus on using
10+
wikia data, not getting it.
11+
12+
Was rewritten as the original wrapper didn't work for a project.
13+
14+
```Python
15+
16+
from wikia import wikia
17+
print(wikia.summary("dancingline", "The_Time"))
18+
# The Time is the 1st normal mode level in Dancing Line.
19+
20+
wikia.search("Runescape", "Forest")
21+
# returns a list of the search word
22+
time = wikia.page("dancingline", "The_Time")
23+
time.title
24+
# u'The Time'
25+
time.url
26+
# u'http://dancingline.wikia.com/wiki/The_Time'
27+
time.content
28+
# u'The Time is the 1st normal mode level in Dancing Line.'...
29+
30+
wikia.set_lang("en") # English
31+
wikia.summary("Runescape", "Runes", sentences=1)
32+
# returns first sentence of the summery
33+
```
34+
35+
Note: this library was designed for ease of use and simplicity, not for advanced use.
36+
37+
Installation
38+
------------
39+
Place the wikia folder in your project and follow the example above. see wikitest.py for example.

0 commit comments

Comments
 (0)