Skip to main content

small cli tool to study using flashcards

Project description

small cli tool to study using fl

  • Free software: BSD license

docs/out.gif

Installation

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]

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:

-
  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

If you want to show the hide the topic instead of the content:

flashcards --inverted 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:

Windows

set PYTEST_ADDOPTS=--cov-append
tox

Other

PYTEST_ADDOPTS=--cov-append tox

Changelog

0.3.0 (2018-11-27)

  • Add ability to hide topic instead of content.

0.1.0 (2017-03-31)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-flashcards-0.3.0.tar.gz (74.1 kB view hashes)

Uploaded source

Built Distribution

python_flashcards-0.3.0-py2.py3-none-any.whl (10.6 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page