djuretic/skritter

Python client for the Skritter API

skritter

skritter is a client for the Skritter API.

Currently a work in progress, with limited API support.

Documentation: http://www.skritter.com/api/v0/docs

Basic Usage

Create a session object and authenticate.

>>> import skritter
>>> session = skritter.session(OAUTH_CLIENT_NAME, OAUTH_CLIENT_SECRET)
>>> session.login('username', 'password')

Get a list of vocabulary lists.

>>> vocablists = skritter.get_vocablists(session)

Examples

Upload a word list

Takes a list of Chinese words, and creates or updates a Skritter list for study.

$ export SKRITTER_OAUTH_CLIENT_NAME='<client name>'
$ export SKRITTER_OAUTH_CLIENT_SECRET='<client secret>'
$ export SKRITTER_USER='<username>''
$ export SKRITTER_PASSWORD='<password>'
$ python examples/upload_list.py 'List title' examples/sample.csv

Download user progress statistics

Download details of the user's progress to a csv file.

$ python examples/progress_stats.py monthly_stats.csv