Tirsvad-Udemy-100-days-of-code/031-flash-card

Files

T

Tirsvad 9c8e294021 MIL-010 plan and documents: release v0.1.0

Milestone MIL-010, story US-001.08, BC-001 and PP-001 amended (the release
of the executable is in scope), CHANGELOG.md for 0.1.0, and links to the
release page in README and the Install page of the wiki. Review records
RC-051 to RC-054, all Go (autonomous mode, not independent).

Task: MIL-010#1
Task: MIL-010#2

2026-10-15 08:37:38 +08:00

2.6 KiB

Raw Permalink Blame History

Install

🌐 English · Dansk · Bahasa Malaysia

Requirements

Python 3.13 or later with Tkinter (on Debian or Ubuntu: sudo apt install python3-tk).
git.
Optional: an internet connection and the speech extra to hear the Malay word.

Get the code

git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/031-flash-card.git
cd 031-flash-card

Create and use a local virtual environment

Windows (PowerShell):

python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

Linux and macOS:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

.[dev] adds pytest, ruff, mypy and import-linter. Use . if you only want to run the program.
If PowerShell refuses to run Activate.ps1, run Set-ExecutionPolicy -Scope CurrentUser RemoteSigned once.
Leave the environment with deactivate; delete the .venv folder to start over.

Spoken Malay word (optional)

python -m pip install -e ".[speech]"

This installs gTTS and playsound==1.2.2. Without it the program works silently.

Run and test

python -m flash_card
python -m pytest

The window test in tests/e2e/ is skipped when no display is available.

Download the executable (Windows)

Download flash-card.exe and flash-card.exe.sha256 from the release page. Compare the SHA-256 hash of the file with the checksum file (certutil -hashfile flash-card.exe SHA256 on Windows). The file is not signed, so Windows may show a SmartScreen warning.

Build an executable (Windows)

python -m pip install -e ".[build,speech]"
python tools/build_executable.py

The script uses PyInstaller and writes dist/flash-card.exe: one file, no console window, with the images, the word list and the spoken word inside. Double-click it to start; Python is not needed to run it.

Your progress is kept in a data/ folder next to the executable (data/words_to_learn.csv).
A data/ms-da.csv next to the executable replaces the word list inside it.
python tools/build_executable.py --no-speech leaves the speech packages out; --clean rebuilds from scratch.
The executable is not committed to the repository. Build it on the system you want to run it on; Windows may show a SmartScreen warning because the file is not signed.

Documentation of the source code

doxygen Doxyfile

The HTML is written to docs/doxygen/html/index.html.

2.6 KiB Raw Permalink Blame History