Skip to main content

An API wrapper for Wanikani (V2)

Project description

wk_logo wanikani_api

https://img.shields.io/pypi/v/wanikani_api.svg https://img.shields.io/travis/Kaniwani/wanikani_api.svg Documentation Status Updates

An API wrapper for Wanikani (V2)

Features

  • Easy access to Wanikani resources associated to your account.

  • Automatic handling of pagination.

  • Automatic fetching of related Subjects

Quickstart

>>> from wanikani_api.client import Client
>>> v2_api_key = "drop_your_v2_api_key_in_here" # You can get it here: https://www.wanikani.com/settings/account
>>> client = Client(v2_api_key)
>>> user_information = client.user_information()
>>> print(user_information)
UserInformation{ username:Tadgh11, level:8, max_level_granted_by_subscription:60, profile_url:https://www.wanikani.com/users/Tadgh11 started_at:2013-07-09 12:02:54.952786+00:00, subscribed:True, current_vacation_started_at:None }
>>> all_vocabulary = client.subjects(types="vocabulary")
>>> for vocab in all_vocabulary:
>>>     print(vocab.meanings[0].meaning) #Vocabulary may have multiple meanings, we just grab the first in the list.
One
One Thing
Seven
Seven Things
Nine
Nine Things
Two
...

TODO

  • Make use of ETags for caching

  • simplify API

  • Improve automatic prefetching of subjects when relevant.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.5.0 (2020-08-18)

  • Remove mock responses that included stage names.

0.5.0 (2020-08-18)

  • Remove passed from resource.

  • Remove srs_stage_name from assignments and reviews

0.4.0 (2020-04-30)

  • Add Preferences to User Information

  • Add Subscription to User Information

0.3.0 (2019-11-09)

  • Add auxiliary_meanings to Subject

0.2.1 (2019-11-05)

  • Fix crash caused by WK removing a field from their API.

0.1.1 (2018-06-26)

  • Change Assignment endpoint to reflect the newly dropped fields from the api (level specifically).

  • Add some proper String representation

  • Work on the Etag cache, bringing it closer to completion.

0.1.0 (2018-06-26)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wanikani_api-0.6.1.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

wanikani_api-0.6.1-py2.py3-none-any.whl (14.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file wanikani_api-0.6.1.tar.gz.

File metadata

  • Download URL: wanikani_api-0.6.1.tar.gz
  • Upload date:
  • Size: 30.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.8.3 requests/2.27.1 setuptools/59.6.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.6.15

File hashes

Hashes for wanikani_api-0.6.1.tar.gz
Algorithm Hash digest
SHA256 16a67d368c1c68f1713ca215e52ec98ce84baf9e50335814c74f98db49bd7718
MD5 18bf3bfda9e68c0390fe1591b73d7b40
BLAKE2b-256 10379663c898372506a9d12ea337450d669e6448730647bd26613dfb2d8a26f3

See more details on using hashes here.

File details

Details for the file wanikani_api-0.6.1-py2.py3-none-any.whl.

File metadata

  • Download URL: wanikani_api-0.6.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.8.3 requests/2.27.1 setuptools/59.6.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.6.15

File hashes

Hashes for wanikani_api-0.6.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0bc2a1e879e7b944fa06726dc1d2d742172326c916dccc300d7b181fc312a2ae
MD5 ec7b7660b4e866f1d20133dbf0cfdc64
BLAKE2b-256 542b29b47b36e9ae46f4235a3b815d6cf0602a63ecb7f1478ef9d9bc4d404dd9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page