{
    "info": {
        "author": "sttlr",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.7",
            "Programming Language :: Python :: Implementation :: CPython",
            "Programming Language :: Python :: Implementation :: PyPy"
        ],
        "description": "spacedr\n=======\n\nSpaced Repetition API\n---------------------\n\nEnhance your learning speed with **Spaced Repetition** technique. It uses increasing intervals of time between card reviews.\n\nBut now you have **API**. Create cards, organise them into decks, study and actually review.\n\n*And there is no* ``session`` *object to pass it everywhere.*\n\nInstallation\n------------\n\n.. code-block:: bash\n\n    $ pip install spacedr\n\nUsage\n-----\n\nAt first, you need to import the module:\n\n.. code-block:: python\n\n    >>> import spacedr\n\nAnd initialise the database:\n\n.. code-block:: python\n\n    >>> spacedr.db_init()\n\nCreate a deck\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: python\n\n    >>> spacedr.create_deck(name='Test Deck', description='Just a test.')\n\nGet a deck\n\"\"\"\"\"\"\"\"\"\"\n\nYou can get a **deck id from a card** *(which you get using* ``get_cards_to_review`` *or* ``get_cards_to_study`` *functions)*:\n\n.. code-block:: python\n\n    >>> deck_id = card.deck_id\n\nAnd then use this to get the ``deck`` object.\n\n.. code-block:: python\n\n    >>> deck = spacedr.get_deck_by_id(deck_id)\n\nCreate a card\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: python\n\n    >>> spacedr.create_card(deck,\n    ...                     question='What is the meaning of life?',\n    ...                     answers=[42, '42'])\n\nUpdate a card\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nYou have to update a card each time the user answers.\n\nIf answer is right, card's level will be increased, othervise decreased. And the card will be postponed accordingly.\n\n.. code-block:: python\n\n    >>> spacedr.update_card(card, answer='43')\n\nGet cards to study\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nYou will get a number of cards *(limited by* ``num``*)*, that haven't been practiced, in the given deck.\n\n.. code-block:: python\n\n    >>> spacedr.get_cards_to_study(deck, num=20)\n    [...]\n\nGet cards to review\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nYou will get a number of cards, that need to be reviewed, in the given deck.\n\n.. code-block:: python\n\n    >>> spacedr.get_cards_to_review(deck)\n    [...]\n\nEdit a deck\n\"\"\"\"\"\"\"\"\"\"\"\n\nYou have to pass ``name`` and ``description`` as keyword arguments:\n\n.. code-block:: python\n\n    >>> spacedr.edit_deck(deck, name='test2', description='new one')\n\nEdit a card\n\"\"\"\"\"\"\"\"\"\"\"\n\nYou have to pass ``deck_id`` *(replace to an another deck)*, ``question`` and ``answers`` as keyword arguments:\n\n.. code-block:: python\n\n    >>> spacedr.edit_card(card, deck_id=deck_id, question='What is life?',\n    ...                   answers=[42])\n\nDelete a deck\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nThe cards assigned to given deck will be deleted too:\n\n.. code-block:: python\n\n    >>> spacedr.delete_deck(deck)\n\nDelete a card\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: python\n\n    >>> spacedr.delete_card(card)\n\nExport a deck\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nExport the deck from a file descriptor:\n\n.. code-block:: python\n\n    >>> with open('mydeck.json', 'w') as file_d:\n    ...     spacedr.export_deck(deck, file_d)\n\n\nImport a deck\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nImport the deck from a file descriptor:\n\n.. code-block:: python\n\n    >>> with open('mydeck.json') as file_d:\n    ...     spacedr.import_deck(deck, file_d)\n\n.. note::\n\n    The deck and the cards will be imported as new ones. The old won't be removed.",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.com/sttlr/spacedr",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "spacedr",
        "package_url": "https://pypi.org/project/spacedr/",
        "platform": "",
        "project_url": "https://pypi.org/project/spacedr/",
        "project_urls": {
            "Homepage": "http://github.com/sttlr/spacedr"
        },
        "release_url": "https://pypi.org/project/spacedr/1.0.1/",
        "requires_dist": null,
        "requires_python": ">=3.5",
        "summary": "Spaced Repetition API",
        "version": "1.0.1"
    },
    "last_serial": 4572984,
    "releases": {
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8872f04bd00648d62a41025160129a62",
                    "sha256": "7918b32b7616f4d8fd3830f9980951d469471fbcf52f77af170b0d67cf564ed2"
                },
                "downloads": -1,
                "filename": "spacedr-1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "8872f04bd00648d62a41025160129a62",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 16295,
                "upload_time": "2018-11-24T18:17:09",
                "url": "https://files.pythonhosted.org/packages/76/05/b54131d96e1d53ad6ff85b12c3e89ab58c387a621e8b522ec0ee299f40e0/spacedr-1.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6f671ff23c8c84fcdf70cadbde4ebd82",
                    "sha256": "169a0bc123e942017c26c6b832b4adab505bd2c3c1c9f4309472d91e0aa8dbe6"
                },
                "downloads": -1,
                "filename": "spacedr-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6f671ff23c8c84fcdf70cadbde4ebd82",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 16267,
                "upload_time": "2018-12-07T18:54:45",
                "url": "https://files.pythonhosted.org/packages/fd/ad/c74f815c20e531226039ff630b6ac482e02ec39a56f58a0af073ada7b664/spacedr-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6f671ff23c8c84fcdf70cadbde4ebd82",
                "sha256": "169a0bc123e942017c26c6b832b4adab505bd2c3c1c9f4309472d91e0aa8dbe6"
            },
            "downloads": -1,
            "filename": "spacedr-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6f671ff23c8c84fcdf70cadbde4ebd82",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 16267,
            "upload_time": "2018-12-07T18:54:45",
            "url": "https://files.pythonhosted.org/packages/fd/ad/c74f815c20e531226039ff630b6ac482e02ec39a56f58a0af073ada7b664/spacedr-1.0.1.tar.gz"
        }
    ]
}