Skip to main content

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.

Metadata

Release files for wanikani-api 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wanikani-api 0.6.1
File Size Uploaded Provenance Actions
wanikani_api-0.6.1.tar.gz 30.4 kB Without provenance Details for wanikani_api-0.6.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for wanikani-api 0.6.1
File Interpreter ABI Platform Actions
wanikani_api-0.6.1-py2.py3-none-any.whl Python 3, Python 2 none any Details for wanikani_api-0.6.1-py2.py3-none-any.whl

Total release size: 44.3 kB

Release files / wanikani_api-0.6.1.tar.gz

Download URL wanikani_api-0.6.1.tar.gz
Size 30.4 kB
Tags Source
SHA-256 checksum
How to use checksums
16a67d368c1c68f1713ca215e52ec98ce84baf9e50335814c74f98db49bd7718
BLAKE2b-256 checksum
How to use checksums
10379663c898372506a9d12ea337450d669e6448730647bd26613dfb2d8a26f3
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / wanikani_api-0.6.1-py2.py3-none-any.whl

Download URL wanikani_api-0.6.1-py2.py3-none-any.whl
Size 14.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
0bc2a1e879e7b944fa06726dc1d2d742172326c916dccc300d7b181fc312a2ae
BLAKE2b-256 checksum
How to use checksums
542b29b47b36e9ae46f4235a3b815d6cf0602a63ecb7f1478ef9d9bc4d404dd9
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for wanikani-api 0.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page