Tirsvad
02b537e538
Task: MIL-003#1 Task: MIL-003#2 Task: MIL-003#3 Task: MIL-003#4 Task: MIL-003#5 Task: MIL-003#6
U.S. States Game
A quiz game from Udemy's 100 Days of Code: The Complete Python Pro Bootcamp (day 25): a Turtle window shows a blank map of the United States, you type state names, and every correct guess appears on the map. When you leave, the states you missed are saved to states_to_learn.csv.
Status: under construction. The tooling and layout are in place; the game logic and the Turtle screen follow in the next milestones.
Requirements
- Python 3.13 or newer, with
tkinter(Turtle needs it; the python.org installers and the Windows Store build include it) git- Optional: Doxygen to build the source documentation
The game has no runtime dependencies. pytest is installed only for development.
Set up
Create a local virtual environment named .venv in the project folder, upgrade pip and install the project with its test tool.
Windows powershell
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-us-states-game.git
cd 025-us-states-game
python -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 CurrentUser RemoteSigned once.
Linux debian
sudo apt install python3 python3-venv python3-tk git
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-us-states-game.git
cd 025-us-states-game
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"
MacOS
git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/025-us-states-game.git
cd 025-us-states-game
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"
Run
With the virtual environment active:
python -m us_states_game
Type a state name in the prompt. Type exit to quit; the states you did not name are written to states_to_learn.csv in the current folder.
Run the tests
python -m pytest
The tests need no display.
Continuous integration
.gitea/workflows/run-tests.yml runs on every push to main and on every pull request: it sets up Python 3.13, installs the project with python -m pip install -e ".[dev]", then runs ruff, mypy, yamllint and python -m pytest.
Build the source documentation
The source uses Doxygen comments. With Doxygen installed:
doxygen Doxyfile
Open docs/build/doxygen/index.html in a browser.
Project layout
| Path | What it is |
|---|---|
src/us_states_game/ |
The game package: constants, game logic and the Turtle screen |
src/us_states_game/data/ |
50_states.csv and blank_states_img.gif from the course |
tests/ |
pytest tests |
docs/ |
Project documents: business case, plan, milestones, review records |
Doxyfile |
Doxygen configuration |
pyproject.toml |
Project configuration |
.gitea/workflows/run-tests.yml |
Continuous integration |
License
GNU Affero General Public License v3.0. See LICENSE.
Links
Appendix: Project documents
| Document | What it tells you |
|---|---|
| Business Case | Why the project exists, its scope and success criteria |
| Stakeholder Analysis | Who is involved |
| Project Plan | The gateways and their schedule |
| Milestones | One document per gateway: Go/No-Go criteria and tasks |
| Artifact registry | Where each document type lives |