Flashcard CLI is a powerful and versatile command-line tool designed to help you learn and memorize information effectively using flashcards. Whether you're a student, a professional, or simply someone who enjoys learning, Flashcard CLI provides a convenient and engaging way to study and review your knowledge.
- Easy to Use: Simple and intuitive command-line interface.
- Customizable: Create and manage your own flashcard decks.
- Interactive Learning: Engaging learning sessions with performance tracking.
- Terminal-Based: Study without distractions, right in your terminal.
pip install flashcard-cli(Image: Screenshot of the installation process)
flashcard add
This command will prompt you to enter a question and answer for your flashcard. The flashcard will be saved to flashcards.json by default.
flashcard start
This command will start a learning session, presenting each flashcard in a visually appealing card-like panel. The system will wait for you to press Enter to reveal the answer, then ask if you got it right. After all flashcards, it will show a summary of your performance.
flashcard manage: manag flascard with edit and delete.
Make sure that the Flashcard CLI is installed correctly and that the flashcard command is in your system's PATH.
To install in editable mode:
pip install -e .To publish the package to PyPI, you need to build the package and then upload it to PyPI.
python -m buildThis will create a dist directory with the built package.
twine upload dist/*Note: You will need to have twine installed (pip install twine) and have a PyPI account.
To automate the release process to PyPI, you can set up a GitHub workflow. See .github/workflows/release.yml for the workflow configuration.
Note:
- You will need to configure a PyPI API token as a secret in your GitHub repository settings.
Contributions are welcome! Please submit a pull request with your changes.
This project is licensed under the MIT License.