{ "info": { "author": "Aaron Jones", "author_email": "aaron@jonesinator.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.4" ], "description": "Crabigator\n==========\n[![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)\n\nA very thin Python wrapper over the [WaniKani\nAPI](https://www.wanikani.com/api) (WaniKani is a tool for leaning Japanese\nvocabulary). The aim is to model the API as closely as possible while ensuring\nthe correct Python type is used for each field in the API. The syntax for using\nthe library has been made as simple as possible.\n\nInstallation\n------------\n### Stable Versions\nTo install for all users `sudo pip install crabigator`\n\nTo install for a single user `pip install --user crabigator`\n\n### Development Versions\nFirst clone this repository and cd to it.\n\nTo install for all users `sudo python setup.py install`\n\nTo install for a single user `python setup.py --user install`\n\nUsage\n-----\n1. Import the WaniKani class. `from crabigator.wanikani import WaniKani`\n2. Instantiate a WaniKani instance with your API key.\n `wanikani = WaniKani('my_api_key')`\n3. Get any endpoint specified by the API docs (dashes replaced with\n underscores).\n * `wanikani.user_information`\n * `wanikani.study_queue`\n * `wanikani.level_progression`\n * `wanikani.srs_distribution`\n * `wanikani.recent_unlocks`\n * `wanikani.critical_items`\n * `wanikani.radicals`\n * `wanikani.kanji`\n * `wanikani.vocabulary`\n4. From any of the above endpoints in #3 the output fields in the\n required-information key can be retrieved. For example:\n * `print(wanikani.user_information.username)`\n * `print(wanikani.study_queue.next_review_date)`\n * `print(wanikani.level_progression.kanji_total)`\n * `print(wanikani.srs_distribution.master.total)`\n * `print(wanikani.recent_unlocks[0])`\n * `print(wanikani.critical_items[0])`\n * `print(wanikani.radicals[0])`\n * `print(wanikani.kanji[0])`\n * `print(wanikani.vocabulary[0])`\n5. If you need to pass arguments to the API then the following functions will\n do that.\n * `wanikani.get_recent_unlocks(limit=10)`\n * `wanikani.get_critical_items(percent=75)`\n * `wanikani.get_radicals(levels=[2,3,4])`\n * `wanikani.get_kanji(levels=[5,6,7])`\n * `wanikani.get_vocabulary(levels=[8,9,10])`\n\nNotes\n-----\n* Everything is a property of a Python object.\n* All API responses can be easily printed for debugging.\n* All dates in API responses are converted to datetime objects.\n* All comma-separated lists in API responses are converted to arrays of strings\n for easier iteration over multiple readings and meanings.", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/jonesinator/crabigator/", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "crabigator", "package_url": "https://pypi.org/project/crabigator/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/crabigator/", "project_urls": { "Homepage": "http://github.com/jonesinator/crabigator/" }, "release_url": "https://pypi.org/project/crabigator/0.1.5/", "requires_dist": null, "requires_python": null, "summary": "Python Library for WaniKani", "version": "0.1.5" }, "last_serial": 1694098, "releases": { "0.1.3": [ { "comment_text": "", "digests": { "md5": "5b097fd93fb993f2f0074a0e342961f8", "sha256": "2e854975375f69d848a9945b76859556d7d9aeac4d7c92b6c3b2b8e8ca0c2d56" }, "downloads": -1, "filename": "crabigator-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5b097fd93fb993f2f0074a0e342961f8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7124, "upload_time": "2015-08-23T18:52:27", "url": "https://files.pythonhosted.org/packages/9f/70/8bde001d9e154688a8e28ef637c593aa2bcc62845a8c4fe6f4fa4bee6956/crabigator-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ac99dd468e0d83bc790b2f57cbce2d84", "sha256": "da2cc8f175c251617adae02beafbc900588728b10e315b1f59854c6890a2c1ac" }, "downloads": -1, "filename": "crabigator-0.1.3.tar.gz", "has_sig": false, "md5_digest": "ac99dd468e0d83bc790b2f57cbce2d84", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4316, "upload_time": "2015-08-23T18:52:36", "url": "https://files.pythonhosted.org/packages/cb/ae/80b2b9c664ea9627748e013f7bf42df645b3541561ca55c6d4da4b667e63/crabigator-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "ddfd48cac6dc279fce3d3f68b19668d3", "sha256": "a14ceab5fd3ac1572cb37cfa349b369599bff394a473f4856323a9d20f067c68" }, "downloads": -1, "filename": "crabigator-0.1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ddfd48cac6dc279fce3d3f68b19668d3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8780, "upload_time": "2015-08-25T22:21:13", "url": "https://files.pythonhosted.org/packages/54/58/dbf79cd6c608f29ea33981da162092f8a7c593124adf58d5f310da9e265b/crabigator-0.1.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2260e74086ae9d6be5f8fa18d7bf2188", "sha256": "d61c72743b0da9279bc15cfbac8e4982dd7e79ac82180a3ba262dc8bed8bc15d" }, "downloads": -1, "filename": "crabigator-0.1.4-py3.4.egg", "has_sig": false, "md5_digest": "2260e74086ae9d6be5f8fa18d7bf2188", "packagetype": "bdist_egg", "python_version": "3.4", "requires_python": null, "size": 13359, "upload_time": "2015-08-26T07:06:33", "url": "https://files.pythonhosted.org/packages/3a/d4/fcf120472a9a32048067b2d312ccf1e85c04dec21ad58adc64da9e721f43/crabigator-0.1.4-py3.4.egg" }, { "comment_text": "", "digests": { "md5": "858e0fcce3ac0a811658a74c5bb00827", "sha256": "89e441030324af8a7ce44267b46601091ae594780216b0e261b01830895d6a76" }, "downloads": -1, "filename": "crabigator-0.1.4.tar.gz", "has_sig": false, "md5_digest": "858e0fcce3ac0a811658a74c5bb00827", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5924, "upload_time": "2015-08-25T22:21:09", "url": "https://files.pythonhosted.org/packages/60/59/4a6daadb9a591baf3e8a471fa97b3a95994f9417859e6fb8a411e33ee098/crabigator-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "a190dade4143350b03ca2f937064ee42", "sha256": "610cb81bc2f930dfbbdadbc5107ac5192a75b08ff8ca8e38172f2ebc41c1ef14" }, "downloads": -1, "filename": "crabigator-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a190dade4143350b03ca2f937064ee42", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8722, "upload_time": "2015-08-26T07:06:42", "url": "https://files.pythonhosted.org/packages/05/bd/21f92692a836a9cf76c6248f92ad8f102c31a21548f928ea3f0a9371483f/crabigator-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c2945589cbc29d02af36b5ac29c5837d", "sha256": "1bb2b649ea3f3e64e09275eb4ae330f05e4b6c5f051f8dd834f3eb28314a412c" }, "downloads": -1, "filename": "crabigator-0.1.5.tar.gz", "has_sig": false, "md5_digest": "c2945589cbc29d02af36b5ac29c5837d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6669, "upload_time": "2015-08-26T07:06:37", "url": "https://files.pythonhosted.org/packages/c7/ba/2bcc48a08e50623dbc8dbeb57a1e1a13848c78390ef1dd3cc0ea5a41d79d/crabigator-0.1.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a190dade4143350b03ca2f937064ee42", "sha256": "610cb81bc2f930dfbbdadbc5107ac5192a75b08ff8ca8e38172f2ebc41c1ef14" }, "downloads": -1, "filename": "crabigator-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a190dade4143350b03ca2f937064ee42", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8722, "upload_time": "2015-08-26T07:06:42", "url": "https://files.pythonhosted.org/packages/05/bd/21f92692a836a9cf76c6248f92ad8f102c31a21548f928ea3f0a9371483f/crabigator-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c2945589cbc29d02af36b5ac29c5837d", "sha256": "1bb2b649ea3f3e64e09275eb4ae330f05e4b6c5f051f8dd834f3eb28314a412c" }, "downloads": -1, "filename": "crabigator-0.1.5.tar.gz", "has_sig": false, "md5_digest": "c2945589cbc29d02af36b5ac29c5837d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6669, "upload_time": "2015-08-26T07:06:37", "url": "https://files.pythonhosted.org/packages/c7/ba/2bcc48a08e50623dbc8dbeb57a1e1a13848c78390ef1dd3cc0ea5a41d79d/crabigator-0.1.5.tar.gz" } ] }