Add README, screenshots and wiki in English, Danish and Bahasa Malaysia
CI / Test on Python 3.13 (push) Successful in 55s
CI / Test on Python 3.13 (push) Successful in 55s
Task: MIL-003#1 Task: MIL-003#2 Refs #14 Refs #15 Refs #16 Refs #17 Refs #18
This commit is contained in:
@@ -0,0 +1,43 @@
|
||||
# Udvikling
|
||||
|
||||
🌐 [English](Development) · **Dansk** · [Bahasa Melayu](Development-ms)
|
||||
|
||||
Sæt projektet op først ([Installation](Install-da)). Udvidelsen `dev` installerer pytest, ruff, mypy og import-linter.
|
||||
|
||||
## Kør testene
|
||||
|
||||
```bash
|
||||
python -m pytest
|
||||
```
|
||||
|
||||
## Kør de kontroller, CI kører
|
||||
|
||||
```bash
|
||||
python -m ruff check .
|
||||
python -m mypy
|
||||
lint-imports
|
||||
```
|
||||
|
||||
## Byg kildedokumentationen
|
||||
|
||||
```bash
|
||||
doxygen Doxyfile
|
||||
```
|
||||
|
||||
Åbn `build/html/index.html`. Installér Doxygen fra [doxygen.nl](https://www.doxygen.nl/) eller din pakkehåndtering.
|
||||
|
||||
## Kodens opbygning
|
||||
|
||||
| Mappe | Indhold |
|
||||
| --- | --- |
|
||||
| `src/nato_alphabet/domain/` | Staveregelen, uden input og output |
|
||||
| `src/nato_alphabet/application/` | Use casen og dens porte |
|
||||
| `src/nato_alphabet/adapters/` | CSV-læseren og konsollen |
|
||||
| `src/nato_alphabet/constants.py` | Alle programmets konstanter |
|
||||
| `tests/` | pytest-tests, som spejler `src/` |
|
||||
|
||||
Afhængigheder peger indad: adapters kender applikationen, applikationen kender domænet. import-linter håndhæver det.
|
||||
|
||||
## Pull requests
|
||||
|
||||
Én gren og én pull request pr. milepæl; CI skal være grøn. Projektet følger SQA- og QC-frameworket i `framework/`; se `docs/` for planen og review-optegnelserne.
|
||||
@@ -0,0 +1,43 @@
|
||||
# Pembangunan
|
||||
|
||||
🌐 [English](Development) · [Dansk](Development-da) · **Bahasa Melayu**
|
||||
|
||||
Sediakan projek dahulu ([Pemasangan](Install-ms)). Pilihan tambahan `dev` memasang pytest, ruff, mypy dan import-linter.
|
||||
|
||||
## Jalankan ujian
|
||||
|
||||
```bash
|
||||
python -m pytest
|
||||
```
|
||||
|
||||
## Jalankan semakan yang dijalankan oleh CI
|
||||
|
||||
```bash
|
||||
python -m ruff check .
|
||||
python -m mypy
|
||||
lint-imports
|
||||
```
|
||||
|
||||
## Bina dokumentasi sumber
|
||||
|
||||
```bash
|
||||
doxygen Doxyfile
|
||||
```
|
||||
|
||||
Buka `build/html/index.html`. Pasang Doxygen dari [doxygen.nl](https://www.doxygen.nl/) atau pengurus pakej anda.
|
||||
|
||||
## Susun atur kod
|
||||
|
||||
| Folder | Kandungan |
|
||||
| --- | --- |
|
||||
| `src/nato_alphabet/domain/` | Peraturan ejaan, tanpa input dan output |
|
||||
| `src/nato_alphabet/application/` | Kes guna dan portnya |
|
||||
| `src/nato_alphabet/adapters/` | Pembaca CSV dan konsol |
|
||||
| `src/nato_alphabet/constants.py` | Semua pemalar program |
|
||||
| `tests/` | Ujian pytest, mencerminkan `src/` |
|
||||
|
||||
Kebergantungan menghala ke dalam: adapter mengenali aplikasi, aplikasi mengenali domain. import-linter menguatkuasakannya.
|
||||
|
||||
## Pull request
|
||||
|
||||
Satu cabang dan satu pull request bagi setiap milestone; CI mesti hijau. Projek ini mengikut rangka kerja SQA dan QC dalam `framework/`; lihat `docs/` untuk pelan dan rekod semakan.
|
||||
@@ -0,0 +1,43 @@
|
||||
# Development
|
||||
|
||||
🌐 **English** · [Dansk](Development-da) · [Bahasa Melayu](Development-ms)
|
||||
|
||||
Set up the project first ([Install](Install)). The `dev` extra installs pytest, ruff, mypy and import-linter.
|
||||
|
||||
## Run the tests
|
||||
|
||||
```bash
|
||||
python -m pytest
|
||||
```
|
||||
|
||||
## Run the checks that CI runs
|
||||
|
||||
```bash
|
||||
python -m ruff check .
|
||||
python -m mypy
|
||||
lint-imports
|
||||
```
|
||||
|
||||
## Build the source documentation
|
||||
|
||||
```bash
|
||||
doxygen Doxyfile
|
||||
```
|
||||
|
||||
Open `build/html/index.html`. Install Doxygen from [doxygen.nl](https://www.doxygen.nl/) or your package manager.
|
||||
|
||||
## Code layout
|
||||
|
||||
| Folder | Content |
|
||||
| --- | --- |
|
||||
| `src/nato_alphabet/domain/` | The spelling rule, with no input or output |
|
||||
| `src/nato_alphabet/application/` | The use case and its ports |
|
||||
| `src/nato_alphabet/adapters/` | The CSV reader and the console |
|
||||
| `src/nato_alphabet/constants.py` | Every literal of the program |
|
||||
| `tests/` | pytest tests, mirroring `src/` |
|
||||
|
||||
Dependencies point inward: adapters know the application, the application knows the domain. import-linter enforces it.
|
||||
|
||||
## Pull requests
|
||||
|
||||
One branch and one pull request per milestone; CI must be green. The project follows the SQA and QC framework in `framework/`; see `docs/` for the plan and the review records.
|
||||
@@ -0,0 +1,23 @@
|
||||
# NATO-alfabet
|
||||
|
||||
🌐 [English](Home) · **Dansk** · [Bahasa Melayu](Home-ms)
|
||||
|
||||
Et konsolprogram, der staver et ord med det fonetiske NATO-alfabet. Det er opgaven fra dag 26 i Udemys "100 Days of Code: The Complete Python Pro Bootcamp" og viser list comprehensions og dictionary comprehensions. Det kræver Python 3.13 eller nyere og har ingen runtime-afhængigheder.
|
||||
|
||||
|
||||
|
||||
| Side | Læs den, når du vil |
|
||||
| --- | --- |
|
||||
| [Installation](Install-da) | Oprette et lokalt `.venv` og installere projektet på Windows, Linux eller macOS |
|
||||
| [Brug](Usage-da) | Køre programmet og læse dets output |
|
||||
| [Udvikling](Development-da) | Køre testene og kontrollerne og bygge kildedokumentationen |
|
||||
|
||||
## Hvem det er til
|
||||
|
||||
- **Kursister**, der vil have en læsbar løsning med opgavens funktionsnavne (`load_nato_dict`, `generate_phonetic`) at sammenligne med deres egen.
|
||||
- **GitHub-besøgende**, der vil se et lille, testet Python-projekt uden runtime-afhængigheder.
|
||||
|
||||
## Links
|
||||
|
||||
- [Repository](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet)
|
||||
- [Fejl og ønsker](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet/issues)
|
||||
@@ -0,0 +1,23 @@
|
||||
# Abjad NATO
|
||||
|
||||
🌐 [English](Home) · [Dansk](Home-da) · **Bahasa Melayu**
|
||||
|
||||
Alat konsol yang mengeja satu perkataan dengan abjad fonetik NATO. Ia ialah tugasan hari ke-26 dalam "100 Days of Code: The Complete Python Pro Bootcamp" di Udemy dan menunjukkan list comprehension serta dictionary comprehension. Ia memerlukan Python 3.13 atau lebih baharu dan tidak mempunyai kebergantungan masa jalan.
|
||||
|
||||
|
||||
|
||||
| Halaman | Baca apabila anda mahu |
|
||||
| --- | --- |
|
||||
| [Pemasangan](Install-ms) | Mencipta `.venv` setempat dan memasang projek di Windows, Linux atau macOS |
|
||||
| [Penggunaan](Usage-ms) | Menjalankan program dan membaca outputnya |
|
||||
| [Pembangunan](Development-ms) | Menjalankan ujian dan semakan serta membina dokumentasi sumber |
|
||||
|
||||
## Untuk siapa
|
||||
|
||||
- **Peserta kursus** yang mahukan penyelesaian yang mudah dibaca dengan nama fungsi tugasan (`load_nato_dict`, `generate_phonetic`) untuk dibandingkan dengan penyelesaian sendiri.
|
||||
- **Pelawat GitHub** yang mahukan projek Python kecil yang diuji tanpa kebergantungan masa jalan.
|
||||
|
||||
## Pautan
|
||||
|
||||
- [Repositori](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet)
|
||||
- [Penjejak isu](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet/issues)
|
||||
@@ -0,0 +1,23 @@
|
||||
# NATO alphabet
|
||||
|
||||
🌐 **English** · [Dansk](Home-da) · [Bahasa Melayu](Home-ms)
|
||||
|
||||
A console tool that spells a word with the NATO phonetic alphabet. It is the Day 26 assignment of Udemy's "100 Days of Code: The Complete Python Pro Bootcamp" and shows list and dictionary comprehensions. It needs Python 3.13 or newer and has no runtime dependencies.
|
||||
|
||||
|
||||
|
||||
| Page | Read it when you want to |
|
||||
| --- | --- |
|
||||
| [Install](Install) | Create a local `.venv` and install the project on Windows, Linux or macOS |
|
||||
| [Usage](Usage) | Run the program and read its output |
|
||||
| [Development](Development) | Run the tests, the checks and build the source documentation |
|
||||
|
||||
## Who it is for
|
||||
|
||||
- **Course participants** who want a readable solution with the assignment's function names (`load_nato_dict`, `generate_phonetic`) to compare with their own.
|
||||
- **GitHub viewers** who want a small, tested Python project with no runtime dependencies.
|
||||
|
||||
## Links
|
||||
|
||||
- [Repository](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet)
|
||||
- [Issue tracker](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet/issues)
|
||||
@@ -0,0 +1,57 @@
|
||||
# Installation
|
||||
|
||||
🌐 [English](Install) · **Dansk** · [Bahasa Melayu](Install-ms)
|
||||
|
||||
## Det skal du bruge
|
||||
|
||||
- Python 3.13 eller nyere med modulet `venv`
|
||||
- Git
|
||||
|
||||
## Trin
|
||||
|
||||
Alle systemer gør de samme fire ting: klon repository'et, opret et virtuelt miljø kaldet `.venv`, opgradér pip og installér projektet.
|
||||
|
||||
### Windows PowerShell
|
||||
|
||||
```powershell
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
py -3.13 -m venv .venv
|
||||
.\.venv\Scripts\Activate.ps1
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
Hvis PowerShell afviser aktiveringsscriptet, så kør først `Set-ExecutionPolicy -Scope Process RemoteSigned`. Det gælder kun for det vindue.
|
||||
|
||||
### Linux Debian
|
||||
|
||||
```bash
|
||||
sudo apt install git python3 python3-venv
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
### macOS
|
||||
|
||||
```bash
|
||||
brew install python@3.13 git
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
python3.13 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Tjek at det virker
|
||||
|
||||
```bash
|
||||
python -m nato_alphabet
|
||||
```
|
||||
|
||||
Skriv et ord. Du skal se dets kodeord. Næste side: [Brug](Usage-da).
|
||||
@@ -0,0 +1,57 @@
|
||||
# Pemasangan
|
||||
|
||||
🌐 [English](Install) · [Dansk](Install-da) · **Bahasa Melayu**
|
||||
|
||||
## Apa yang diperlukan
|
||||
|
||||
- Python 3.13 atau lebih baharu dengan modul `venv`
|
||||
- Git
|
||||
|
||||
## Langkah
|
||||
|
||||
Semua sistem melakukan empat perkara yang sama: klon repositori, cipta persekitaran maya bernama `.venv`, naik taraf pip dan pasang projek.
|
||||
|
||||
### Windows PowerShell
|
||||
|
||||
```powershell
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
py -3.13 -m venv .venv
|
||||
.\.venv\Scripts\Activate.ps1
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
Jika PowerShell enggan menjalankan skrip pengaktifan, jalankan `Set-ExecutionPolicy -Scope Process RemoteSigned` dahulu. Ia hanya terpakai pada tetingkap itu.
|
||||
|
||||
### Linux Debian
|
||||
|
||||
```bash
|
||||
sudo apt install git python3 python3-venv
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
### macOS
|
||||
|
||||
```bash
|
||||
brew install python@3.13 git
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
python3.13 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Semak ia berfungsi
|
||||
|
||||
```bash
|
||||
python -m nato_alphabet
|
||||
```
|
||||
|
||||
Masukkan satu perkataan. Anda akan melihat kata kodnya. Seterusnya: [Penggunaan](Usage-ms).
|
||||
@@ -0,0 +1,57 @@
|
||||
# Install
|
||||
|
||||
🌐 **English** · [Dansk](Install-da) · [Bahasa Melayu](Install-ms)
|
||||
|
||||
## What you need
|
||||
|
||||
- Python 3.13 or newer with the `venv` module
|
||||
- Git
|
||||
|
||||
## Steps
|
||||
|
||||
Every system does the same four things: clone the repository, create a virtual environment called `.venv`, upgrade pip, install the project.
|
||||
|
||||
### Windows PowerShell
|
||||
|
||||
```powershell
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
py -3.13 -m venv .venv
|
||||
.\.venv\Scripts\Activate.ps1
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
If PowerShell refuses to run the activation script, run `Set-ExecutionPolicy -Scope Process RemoteSigned` first. It only applies to that window.
|
||||
|
||||
### Linux Debian
|
||||
|
||||
```bash
|
||||
sudo apt install git python3 python3-venv
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
### macOS
|
||||
|
||||
```bash
|
||||
brew install python@3.13 git
|
||||
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet.git
|
||||
cd 026-nato-alphabet
|
||||
python3.13 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Check that it works
|
||||
|
||||
```bash
|
||||
python -m nato_alphabet
|
||||
```
|
||||
|
||||
Enter a word. You should see its code words. Next: [Usage](Usage).
|
||||
@@ -0,0 +1,31 @@
|
||||
# Brug
|
||||
|
||||
🌐 [English](Usage) · **Dansk** · [Bahasa Melayu](Usage-ms)
|
||||
|
||||
Aktivér det virtuelle miljø (se [Installation](Install-da)), og start programmet:
|
||||
|
||||
```bash
|
||||
python -m nato_alphabet
|
||||
```
|
||||
|
||||
Den installerede kommando gør det samme:
|
||||
|
||||
```bash
|
||||
nato-alphabet
|
||||
```
|
||||
|
||||
## Stav et ord
|
||||
|
||||
Programmet spørger efter et ord og skriver NATO-kodeordet for hvert bogstav i rækkefølge. Store og små bogstaver giver samme resultat.
|
||||
|
||||
|
||||
|
||||
## Ugyldigt input
|
||||
|
||||
Et ciffer, et mellemrum eller et tegn er ikke et bogstav. Programmet siger det og spørger igen.
|
||||
|
||||
|
||||
|
||||
## Tryk Ctrl+C eller Ctrl+D
|
||||
|
||||
Afslutter du inputtet (Ctrl+D på Linux og macOS, Ctrl+Z og Enter på Windows) eller trykker Ctrl+C, lukker programmet stille.
|
||||
@@ -0,0 +1,31 @@
|
||||
# Penggunaan
|
||||
|
||||
🌐 [English](Usage) · [Dansk](Usage-da) · **Bahasa Melayu**
|
||||
|
||||
Aktifkan persekitaran maya (lihat [Pemasangan](Install-ms)), kemudian mulakan program:
|
||||
|
||||
```bash
|
||||
python -m nato_alphabet
|
||||
```
|
||||
|
||||
Arahan yang dipasang melakukan perkara yang sama:
|
||||
|
||||
```bash
|
||||
nato-alphabet
|
||||
```
|
||||
|
||||
## Eja satu perkataan
|
||||
|
||||
Program meminta satu perkataan dan mencetak kata kod NATO bagi setiap huruf mengikut urutan. Huruf besar dan huruf kecil memberi keputusan yang sama.
|
||||
|
||||
|
||||
|
||||
## Input tidak sah
|
||||
|
||||
Angka, ruang atau tanda baca bukan huruf. Program memberitahu perkara itu dan bertanya semula.
|
||||
|
||||
|
||||
|
||||
## Tekan Ctrl+C atau Ctrl+D
|
||||
|
||||
Menamatkan input (Ctrl+D di Linux dan macOS, Ctrl+Z kemudian Enter di Windows) atau menekan Ctrl+C menutup program dengan senyap.
|
||||
@@ -0,0 +1,31 @@
|
||||
# Usage
|
||||
|
||||
🌐 **English** · [Dansk](Usage-da) · [Bahasa Melayu](Usage-ms)
|
||||
|
||||
Activate the virtual environment (see [Install](Install)), then start the program:
|
||||
|
||||
```bash
|
||||
python -m nato_alphabet
|
||||
```
|
||||
|
||||
The installed command does the same:
|
||||
|
||||
```bash
|
||||
nato-alphabet
|
||||
```
|
||||
|
||||
## Spell a word
|
||||
|
||||
The program asks for a word and prints the NATO code word of each letter, in order. Upper and lower case give the same result.
|
||||
|
||||
|
||||
|
||||
## Invalid input
|
||||
|
||||
A digit, a space or a punctuation mark is not a letter. The program says so and asks again.
|
||||
|
||||
|
||||
|
||||
## Press Ctrl+C or Ctrl+D
|
||||
|
||||
Ending the input (Ctrl+D on Linux and macOS, Ctrl+Z then Enter on Windows) or pressing Ctrl+C closes the program quietly.
|
||||
@@ -0,0 +1,24 @@
|
||||
**NATO alphabet**
|
||||
|
||||
- [Home](Home)
|
||||
- [Install](Install)
|
||||
- [Usage](Usage)
|
||||
- [Development](Development)
|
||||
|
||||
**Dansk**
|
||||
|
||||
- [Hjem](Home-da)
|
||||
- [Installation](Install-da)
|
||||
- [Brug](Usage-da)
|
||||
- [Udvikling](Development-da)
|
||||
|
||||
**Bahasa Melayu**
|
||||
|
||||
- [Utama](Home-ms)
|
||||
- [Pemasangan](Install-ms)
|
||||
- [Penggunaan](Usage-ms)
|
||||
- [Pembangunan](Development-ms)
|
||||
|
||||
**Links**
|
||||
|
||||
- [Repository](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/026-nato-alphabet)
|
||||
Reference in New Issue
Block a user