Metadata-Version: 1.1
Name: python-flashcards
Version: 0.2.0
Summary: small cli tool to study using flashcards
Home-page: https://github.com/woile/flashcards
Author: Santiago Fraire Willemoes
Author-email: santiwilly@gmail.com
License: BSD
Description: ========
        Overview
        ========
        
        
        
        small cli tool to study using fl
        
        * Free software: BSD license
        
        
        .. image:: docs/out.gif
        
        
        Installation
        ============
        
        The module still does not support python2, so if python3 is not your default, use pip3
        
        ::
        
            pip3 install python-flashcards
        
        What flashcards are
        ===================
        
          A flashcard or flash card is a set of cards bearing information, as words or numbers, on either or both sides, used in classroom drills or in private study. One writes a question on a card and an answer overleaf. `[Wikipedia] <https://en.wikipedia.org/wiki/Flashcard>`_
        
        How does this work
        ==================
        
        ``python-flashcards`` is a small tool, which receives cards from a ``YAML`` file, and shows them in a random order so you can practice.
        
        ``YAML`` format:
        
        .. code-block:: yaml
        
          -
            topic: The topic I will say out loud
            content: The information I'll check after saying out loud what I know
            keywords: reference, words
          -
            topic: Python
            content: Is a widely used high-level programming language for general-purpose programming,
              created by Guido van Rossum and first released in 1991.
            keywords: programming, language
        
        
        Being ``keyword`` the only optional.
        
        Usage
        =====
        
        Let's supouse ``anatomy.yaml`` is your file with information related to anatomy.
        
        ::
        
            flashcards anatomy.yaml
        
        
        If you want the cards in order:
        
        ::
        
            flashcards --ordered meds.yaml
        
        For more help:
        
        ::
        
            flashcards -h
        
        
        Documentation
        =============
        
        https://python-flashcards.readthedocs.io/
        
        Development
        ===========
        
        To run the all tests run::
        
            tox
        
        Note, to combine the coverage data from all the tox environments run:
        
        .. list-table::
            :widths: 10 90
            :stub-columns: 1
        
            - - Windows
              - ::
        
                    set PYTEST_ADDOPTS=--cov-append
                    tox
        
            - - Other
              - ::
        
                    PYTEST_ADDOPTS=--cov-append tox
        
        
        Changelog
        =========
        
        0.1.0 (2017-03-31)
        ------------------
        
        * First release on PyPI.
        
Keywords: flashcards
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
