textual-cards

Table of Contents

• textual-cards
  • About
  • Installation
    • pipx
    • Manual
  • Usage
    • Decks
      • Custom Deck Path
    • Cards
    • Keyboard shortcuts
  • License

About

textual-cards is a simple flashcard app built with textual

Installation

This is not a published package.

pipx

After publishing, this will be the preferred method

pipx install <TBD>

Manual

If you, for whatever reason, want to use it now

git clone https://github.com/joshpaulie/textual-cards
cd textual-cards
python -m venv .venv
<activate venv>
python -m pip -e install .
python -m textual_cards

Usage

In development: The app lacks some functionality as-is

To use the app during development, follow the manual install steps and read below

Anything annotated with 💤 are features yet to be implemented

1. Install
2. Create ~/decks directory, create your deck files
3. Run cards 💤
4. Pick which deck to load up, start studying! 🤓

Decks

Flashcards are collected as "deck" files, in the directory ~/decks. This directory is recursively checked, allowing for the decks to be categorized into subdirectories

• These deck files can be named anything, but are "Pipe (|) seperated values" files
• Each line in the deck file considered a card
• Check out this example deck

Custom Deck Path

If you don't like ~/decks, and directory can be specified. Simply set an environment variable for DECK_PATH

• export DECK_PATH=path/to/deck/files ← Add to your shell rc Linux/MacOS
• Windows instructions

Cards

• are represented as line entries in your deck file
• are pipe (|) seperated, each line using the syntax Question | Answer
• ignore blank lines
• ignore lines starting with # (comments)
• can be styled with Rich's "Console Markup"
  • for example The [green]mitochondria[/] is the _____ of the cell?
• ignore trailing and leading whitespace (tabs, spaces), allowing for cards like
  • How is bexli going to get this package & publish this app when he's done? | He has no idea!

Keyboard shortcuts

All keyboard shortcuts can be found in the footer, expect

• q or escape to exit the app

License

textual-cards is distributed under the terms of the MIT license.