Skip to content

Commit 041b083

Browse files
authored
Update README.md
1 parent 9566f7b commit 041b083

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
# jplookup
22

3+
IMAGE GOES HERE
4+
35
jplookup is a Python tool designed to scrape Japanese word information from Wiktionary. It prioritizes definition relevancies to provide you with the most useful data. The outputs from the `jplookup.scrape(word)` function can then be used to generate a text file that is compatible with Anki flashcards.
46

7+
<br>
8+
59
## Features
610

711
### Scrapes Japanese word data
812
Retrieves detailed word information from Wiktionary.
13+
`jplookup.scrape(EXAMPLE HERE)` returns a list of dictionary objects.
14+
The very first dictionary in the list contains the primary results:
15+
IMAGE GOES HERE
16+
17+
The rest of the list provides further dictionaries gathered from redirect links, in which case the page:
18+
- Has redirects whose contents could not be linked back to the primary first dictionary through mutual matching components (kana).
19+
- Could be a page that has no other real information other than various spellings with kanji, in which case each dictionary in the list will be information pulled for each of these unique spellings, as is the case with "ふろ".<br>IMAGE GOES HERE
920

1021
<br>
1122

@@ -19,6 +30,9 @@ When Wiktionary links to a different page for an alternative spelling, then the
1930
- "撮る" redirects to the Wiktionary page for "とる" and grabs any definitions that are either specified as fitting with "撮る" or definitions with no context/kanji specification at all.
2031
- "取る" redirects to the Wiktionary page for "とる" and grabs any definitions that are either specified as fitting with "取る" or definitions with no context/kanji specification at all.
2132
- "とる" (the hiragana directly) goes to the Wiktionary page for "とる" and grabs all definitions regardless of context specification.
33+
34+
IMAGE GOES HERE
35+
2236
<br>
2337

2438
## Installation

0 commit comments

Comments
 (0)