Metadata-Version: 2.1
Name: polski
Version: 0.0.5
Summary: A command line tool to learn Polish using spaced repetition.
Home-page: http://dirtymonkey.co.uk/polski
Author: Matt Deacalion Stevens
Author-email: matt@dirtymonkey.co.uk
License: MIT
Keywords: polski polish foreign language spaced repetition
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: BSD
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Utilities
License-File: LICENSE.txt
Requires-Dist: docopt (>=0.6.2)
Requires-Dist: fuzzywuzzy (>=0.10.0)
Requires-Dist: peewee (>=2.8.1)

=============
Polski Runner
=============

A command line tool to teach myself Polish using a spaced repetition
algorithm.

.. image:: https://raw.github.com/Matt-Deacalion/Polski/master/run-mode.gif?v=1
    :alt: Run Mode
    :align: center

Installation
------------
You can install *Polski Runner* using pip:

.. code-block:: bash

    $ pip install polski

Usage
-----
Use the `polski` command to run Polski Runner::

    $ polski --help

    Usage:
      polski [--insert | --report] [--database=<path>]
      polski (-h | --help | --version)

    Options:
      --version              show program's version number and exit.
      -h, --help             show this help message and exit.
      -i, --insert           insert new word iterations, starting from today.
      -r, --report           display a report of all daily iterations run.
      -d, --database=<path>  path to the SQLite database [default: db.sqlite3].

If no options are given, it will attempt to run through today's set
of words, if any exist. If there are none, it will go into insert
mode.

License
-------
Copyright © 2016 `Matt Deacalion Stevens`_, released under The `MIT License`_.

.. _Matt Deacalion Stevens: http://dirtymonkey.co.uk
.. _MIT License: http://deacalion.mit-license.org


