Contents¶
Overview¶
docs | |
---|---|
tests | |
package |
small cli tool to study using fl
- Free software: BSD license
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 suppose 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¶
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
|
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Bug reports¶
When reporting a bug please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Documentation improvements¶
Flashcards could always use more documentation, whether as part of the official Flashcards docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/woile/flashcards/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that code contributions are welcome :)
Development¶
To set up flashcards for local development:
Fork flashcards (look for the “Fork” button).
Clone your fork locally:
git clone git@github.com:your_name_here/flashcards.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:
tox
Commit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
- Include passing tests (run
tox
) [1]. - Update documentation when there’s new API, functionality etc.
- Add a note to
CHANGELOG.rst
about the changes. - Add yourself to
AUTHORS.rst
.
[1] | If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request. It will be slower though … |
Tips¶
To run a subset of tests:
tox -e envname -- py.test -k test_myfeature
To run all the test environments in parallel (you need to pip install detox
):
detox
Authors¶
- Santiago Fraire Willemoes - https://woile.github.io
- Elliott King