This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
Crabigator
==========
[![Build Status](https://travis-ci.org/jonesinator/crabigator.svg)](https://travis-ci.org/jonesinator/crabigator) ![License](https://img.shields.io/github/license/jonesinator/crabigator.svg) [![Coverage Status](https://coveralls.io/repos/jonesinator/crabigator/badge.svg?branch=master&service=github)](https://coveralls.io/github/jonesinator/crabigator?branch=master) [![PyPI version](https://badge.fury.io/py/crabigator.svg)](http://badge.fury.io/py/crabigator)

A very thin Python wrapper over the [WaniKani
API](https://www.wanikani.com/api) (WaniKani is a tool for leaning Japanese
vocabulary). The aim is to model the API as closely as possible while ensuring
the correct Python type is used for each field in the API. The syntax for using
the library has been made as simple as possible.

Installation
------------
### Stable Versions
To install for all users `sudo pip install crabigator`

To install for a single user `pip install --user crabigator`

### Development Versions
First clone this repository and cd to it.

To install for all users `sudo python setup.py install`

To install for a single user `python setup.py --user install`

Usage
-----
1. Import the WaniKani class. `from crabigator.wanikani import WaniKani`
2. Instantiate a WaniKani instance with your API key.
`wanikani = WaniKani('my_api_key')`
3. Get any endpoint specified by the API docs (dashes replaced with
underscores).
* `wanikani.user_information`
* `wanikani.study_queue`
* `wanikani.level_progression`
* `wanikani.srs_distribution`
* `wanikani.recent_unlocks`
* `wanikani.critical_items`
* `wanikani.radicals`
* `wanikani.kanji`
* `wanikani.vocabulary`
4. From any of the above endpoints in #3 the output fields in the
required-information key can be retrieved. For example:
* `print(wanikani.user_information.username)`
* `print(wanikani.study_queue.next_review_date)`
* `print(wanikani.level_progression.kanji_total)`
* `print(wanikani.srs_distribution.master.total)`
* `print(wanikani.recent_unlocks[0])`
* `print(wanikani.critical_items[0])`
* `print(wanikani.radicals[0])`
* `print(wanikani.kanji[0])`
* `print(wanikani.vocabulary[0])`
5. If you need to pass arguments to the API then the following functions will
do that.
* `wanikani.get_recent_unlocks(limit=10)`
* `wanikani.get_critical_items(percent=75)`
* `wanikani.get_radicals(levels=[2,3,4])`
* `wanikani.get_kanji(levels=[5,6,7])`
* `wanikani.get_vocabulary(levels=[8,9,10])`

Notes
-----
* Everything is a property of a Python object.
* All API responses can be easily printed for debugging.
* All dates in API responses are converted to datetime objects.
* All comma-separated lists in API responses are converted to arrays of strings
for easier iteration over multiple readings and meanings.
Release History

Release History

0.1.5

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.4

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
crabigator-0.1.5-py2.py3-none-any.whl (8.7 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Aug 26, 2015
crabigator-0.1.5.tar.gz (6.7 kB) Copy SHA256 Checksum SHA256 Source Aug 26, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting