024-snake/README.md

Snake Game (Day 24)

The classic Snake game, built with Python's turtle module. It is the day-24 assignment of Udemy's 100 Days of Code: The Complete Python Pro Bootcamp. Day 24 teaches the local file system and reading and writing files with open and the with keyword, and applies them to the snake game: the scoreboard shows a high score next to the score, the game goes on after a collision instead of ending, and the high score is kept in the file data.txt, so it is still there the next time the game is started.

The game has no runtime dependencies. The code keeps the names of the lectures (Snake, create_snake, move, reset, up, down, left, right, segments, head, game_is_on, Food, Scoreboard, refresh, extend, increase_score, update_scoreboard, high_score) so that you can compare it with your own solution.

This repository continues 021-snake-game and starts from its finished game; docs/project-plan.md tells how the work is split into milestones.

Status: in progress. The repository foundation (this README, the configuration, the constants, the Doxygen settings and the continuous integration workflow) is in place; the game itself, continuous play, the high score and the high score file follow in milestones 2 to 4, and the wiki in milestone 5. The sections below describe the finished game.

Requirements

• Python 3.13 or newer, with tkinter (the turtle module needs it).
• git, to clone the repository.
• Optional: Doxygen to build the source documentation.
• No runtime dependencies. The development tools (pytest, ruff, mypy) are installed into the virtual environment by the dev extra.

Set up

Clone the repository, then create a local virtual environment .venv in its root, upgrade pip and install the project with its development tools. The .venv folder is ignored by git.

git clone https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/024-snake.git
cd 024-snake

Windows powershell

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, allow scripts for this window only with Set-ExecutionPolicy -Scope Process -ExecutionPolicy RemoteSigned and activate again. Python from python.org includes tkinter.

Linux debian

Debian 13 or newer ships Python 3.13. On older releases install Python 3.13 separately.

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

MacOS

brew install python@3.13 python-tk@3.13
python3.13 -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 snake_game

The game itself is added in milestone 2 (see the status above); this section is completed with the controls, the two scores and the high score file in milestones 2 to 5.

Run the tests

The tests need no display: they use fakes instead of real turtles.

pytest

The same checks that continuous integration runs:

python -m pytest
python -m ruff check src tests
python -m ruff format --check src tests
python -m mypy

Continuous integration

.gitea/workflows/ci.yml runs on Gitea Actions on every push and on every pull request. It sets up Python 3.13, upgrades pip, installs .[dev], then runs pytest, ruff (lint and format check) and mypy. It does not build the source documentation: run doxygen Doxyfile yourself, as the next section shows. No step opens a turtle window.

The workflow lives in .gitea/workflows and not in .github/workflows, so GitHub does not run it and pushing to a GitHub mirror needs no workflow permission.

Build the source documentation

The source is documented with Doxygen comments and the Doxyfile in the root. Install Doxygen (winget install DimitriVanHeesch.Doxygen on Windows, sudo apt install doxygen on Debian, brew install doxygen on macOS), then:

doxygen Doxyfile

The HTML is written to build/doxygen/index.html. A warning fails the build.

Project layout

.
├── .gitea/workflows/ci.yml    continuous integration (Gitea Actions)
├── docs/                      business case, plan, milestones, reviews
├── src/snake_game/            the game
│   ├── __init__.py
│   └── constants.py           every constant of the game
├── tests/                     pytest tests
├── Doxyfile                   source documentation settings
├── LICENSE
├── pyproject.toml             project configuration
└── README.md

The remaining modules (snake.py, food.py, scoreboard.py, main.py and __main__.py) are added in milestone 2.

License

GNU Affero General Public License v3.0 only. See LICENSE.