sakuraParisAPI

The Unofficial Sakura Paris Python API (TUSPPAPI)

✨ Because one dictionary is never enough ✨

Table of Contents

• More than just a wrapper (Intro)
• Install the Package
• Documentation

More than just a wrapper

Have you ever wanted to search 40 different Japanese dictionaries at the same time? Well now you can anyways!

Introducing the wrapper that queries the sakura-paris's free Koujien search API（広辞苑無料検索） for a lot of dictionaries. This includes Daijirin, Koujien, Daijisen, and even oddballs like a dictionary for psychological terms（心理学辞典）.

If that wasn't enough, this wrapper allows you to query selected dictionaries at the same time, and also allows searches over the 40 entry limit on sakura-paris! If you've ever been at a loss for which dictionary to pick, you're at the right place!

That's enough talk. Here's an example of how easy it is to use.

#import the package!
from sakuraParisAPI.sakura import JpDict

#create JpDict object
a = JpDict()

#each dictionary will return at most 10 entries (default value is already 10)
a.setMax(10)

#add dictionary to be queries ("広辞苑" is added by default, so this will query 2 dictionaries)
a.addDict("大辞林")

#returns a dictionary where [key = dictionary_name, value = list of Entry]
results = a.search("元気")

#for every dictionary queried
for key in results:
    print("______", key, "______")
    
    #for every entry found in dictionary
    for entry in results[key]:
    
        #print out the word and its definition
        print(entry.getHeading())
        print(entry.getDefinition())
        
    print()

#print out all dictionaries used in this query
print(a.getDict())

Also, by adding a single line before calling search(word), we can query all dictionaries at the same time.

a.addAllDict()

and voila. 40 dictionaries at your fingertips. Minus a couple cause the API returns empty jsons for them. :')

Install the Package

This package can be downloaded using PIP!
Here is the command for the latest version: pip install sakuraParisAPI==0.1.0
SPPAPI has two dependencies: bs4 and requests, and both will also be installed by the above command

Documentation

All public methods of the JpDict and Entry class are listed below.
Please note that the API does not work with a few dictionaries (e.g. 学研古語辞典, NHK日本語発音アクセント辞典). I will be using bs4 or something similar to implement these features later. Especially for the NHK accent dictionary, I hope to return the links to the .wav files for each entry.

JpDict Method	Parameter Types	Return Type	Description
search(word, searchType = 0)	str, int (0 - 2)	dict[str, list[Entry]]	queries active dictionaries for word with search type searchType. searchtype = 0 by default and searches for dictionary entries with prefixes matching word. searchtype = 1 searches for suffixes matching word and searchtype = 2 searches for exact matches only. Returns a dictionary where keys are the name of the dictionary queried and value is a list of Entry
startsWith(word)	str	dict[str, list[Entry]]	Queries dictionary for entries that start with word. Same return type as search.
endsWith(word)	str	dict[str, list[Entry]]	Queries dictionary for entries that end with word. Same return type as search.
completeMatch(word)	str	dict[str, list[Entry]]	Queries dictionary for entries that are exact matches for word. Same return type as search.
setMax(maxEntries)	int	void	Sets the max number of entries (for each dictionary) returned by any of the above functions to maxEntries
addDict(dictionaryName)	str	void	adds dictionaryName to set of dictionaries to be queried if it exists.
addAllDict()		void	adds all possible dictionaries to set of dictionaries to be queried.
enableTags()		void	prevents markdown tags from being removed from the heading and definition fields of Entrys returned in searches.
disableTags()		void	ensures markdown tags are removed from the heading and definition fields of Entrys returned in searches.

Entry Method	Parameter Types	Return Type	Description
getHeading()		str	returns heading listed in dictionary entry.
getDefinition()		str	returns the definition listed in dictionary entry.
getPage()		str	returns page number of dictionary entry
getOffset()		str	returns the offset of the dictionary entry

Note: getPage() and getOffset() do not currently have any use.