Files
031-flash-card/docs/wiki/Install-ms.md
Tirsvad 7c1f1b6423 MIL-012: version 0.2.0, CHANGELOG and links
Version 0.2.0 in pyproject.toml, flash_card.__version__ and the Doxyfile
with a test that keeps the three equal; CHANGELOG entry for 0.2.0; README
and the wiki Install pages link the release pages. The upload limit probe
refused a 1 MB file (413), so the executable is not attached. Review
record RC-071 (Go).

Task: MIL-012#2
Task: MIL-012#3
Task: MIL-012#4
Task: MIL-012#8
2026-10-15 09:39:16 +08:00

2.9 KiB

Pemasangan

🌐 English · Dansk · Bahasa Malaysia

Keperluan

  • Python 3.13 atau lebih baharu dengan Tkinter (pada Debian atau Ubuntu: sudo apt install python3-tk).
  • git.
  • Pilihan: sambungan internet dan tambahan speech jika anda mahu mendengar perkataan Melayu.

Dapatkan kod

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

Cipta dan gunakan persekitaran maya setempat

Windows (PowerShell):

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

Linux dan macOS:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"
  • .[dev] menambah pytest, ruff, mypy dan import-linter. Gunakan . jika anda hanya mahu menjalankan program.
  • Jika PowerShell enggan menjalankan Activate.ps1, jalankan Set-ExecutionPolicy -Scope CurrentUser RemoteSigned sekali.
  • Keluar daripada persekitaran dengan deactivate; padam folder .venv untuk bermula semula.

Perkataan Melayu bersuara (pilihan)

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

Ini memasang gTTS dan playsound==1.2.2. Tanpa tambahan ini program berfungsi tanpa bunyi.

Jalankan dan uji

python -m flash_card
python -m pytest

Ujian tetingkap dalam tests/e2e/ dilangkau apabila tiada paparan.

Keluaran dan fail boleh laku (Windows)

Halaman keluaran v0.2.0 dan v0.1.0 mempunyai nota keluaran. Fail boleh laku belum dilampirkan di sana kerana had muat naik pelayan menolak fail sebesar ini (HTTP 413); bina seperti yang diterangkan di bawah. Fail tidak ditandatangani, jadi Windows mungkin menunjukkan amaran SmartScreen.

Bina fail boleh laku (Windows)

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

Skrip menggunakan PyInstaller dan menulis dist/flash-card.exe: satu fail tanpa tetingkap konsol, dengan imej, senarai perkataan dan suara di dalamnya. Klik dua kali untuk memulakan; Python tidak diperlukan untuk menjalankannya.

  • Kemajuan anda disimpan dalam folder data/ di sebelah fail boleh laku (data/words_to_learn.csv).
  • data/ms-da.csv di sebelah fail boleh laku menggantikan senarai perkataan di dalamnya.
  • python tools/build_executable.py --no-speech meninggalkan pakej suara; --clean membina semula dari awal.
  • Fail boleh laku tidak disimpan dalam repositori. Bina di sistem tempat ia akan dijalankan; Windows mungkin menunjukkan amaran SmartScreen kerana fail tidak ditandatangani.

Dokumentasi kod sumber

doxygen Doxyfile

HTML ditulis ke docs/doxygen/html/index.html.