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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file python-flashcards-0.3.0.tar.gz.

File metadata

  • Download URL: python-flashcards-0.3.0.tar.gz
  • Upload date:
  • Size: 74.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for python-flashcards-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b466a773a32c88c6cbff6f7d66b331e3ed2568c6dfd65993c5d206cd7f5fcc72
MD5 38be8f179b0fab034254c54894b9e991
BLAKE2b-256 8a1dd12af771b92990cb2eae6dcd22310a9747d82c2f0ccb7651f3bbcc2ea85a

See more details on using hashes here.

File details

Details for the file python_flashcards-0.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: python_flashcards-0.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for python_flashcards-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8973f41b5fa12ce47e3dda7760f6d56ef12a60eb0f7f55d0d34d25ac70a6d12b
MD5 5abf4648475586636c82d4dfee1a460d
BLAKE2b-256 b1ec80646c6e1638240515e7c855b9ea743ff339f9a4a6f9e167d0dc0c82bc6b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page