Tirsvad
fed7e17527
Add .gitea/workflows/ci.yml: tests, ruff check, ruff format --check and mypy on every push and pull request, with Python 3.13 on ubuntu-latest. Two things in the first draft would have failed: - It installed the dev tools with `pip install -e ".[dev]"`, but the project declares them as a dependency group, not an extra. pip only warns and exits 0, so pytest, ruff and mypy were missing and the first step died with "No module named pytest". It now runs `pip install -e . --group dev`. - The 10 test cases that use Tk need a display, which a CI runner does not have. The workflow now installs xvfb and python3-tk and runs the tests with xvfb-run, so the display requirement accepted on RC-006 still holds. No test code changes. Checked locally: the YAML parses to the intended eight steps, the install line gives all three tools in a clean environment, and the test, lint, format and type commands pass as written. The Linux display steps have not run yet; they need a runner.
🚀 Hirst Painting
A Python program that draws a Hirst-style spot painting with turtle: a 10 by 10 grid of dots, each coloured at random from a palette extracted from an image with colorgram. It is Day 18 of Udemy's 100 Days of Code course, and a small project delivered through the SQA and QC framework.
📚 Table of Contents
🧭 Overview
The program opens a turtle window and draws 100 dots of size 20, 50 units apart, in 10 rows of 10, centred in the window. Each dot takes a random colour from a palette that colorgram extracts from a reference image. White shades (red, green and blue all at 240 or above) are removed from the palette, because they would be invisible on the white background. The drawing runs without animation, takes well under a second, and the window stays open until you click it.
| Part | What it is for |
|---|---|
src/hirst_painting.py |
The program: the palette (extract_palette and the white-shade filter), the dot positions, the pen setup, the drawing and main |
tests/test_hirst_painting.py |
The tests, 40 test cases for pytest |
assets/ |
The reference image 20260524_132700.jpg, which the palette is taken from |
docs/ |
The project documents; see the appendix |
framework/ |
The SQA and QC framework this project uses, a git submodule |
pyproject.toml |
The Python version, the pinned dependencies, and the settings of ruff, mypy and pytest |
📋 Requirements
- Python 3.13 or newer, with Tk. The
turtlemodule needs Tk to open a window. The python.org and Microsoft Store installers include it; on Debian and Ubuntu the package ispython3-tk. - A display. The program opens a window, and 10 of the 40 test cases, the ones that use Tk, need a display as well.
colorgram.py1.2.0, which brings Pillow, to extract the palette from the image. It is pinned inpyproject.toml.pytest,ruffandmypy, pinned in thedevgroup, to test, format, lint and type-check.- pip 25.1 or newer, for the
--groupoption in the setup command below.
Verified with Python 3.13.14 and Tk 8.6 on Windows 11.
🛠️ Setup
git clone ssh://git@git.tirsystem.com:10022/Tirsvad-Udemy-100-days-of-code/018-hirst-painting.git
cd 018-hirst-painting
python -m venv .venv
source .venv/bin/activate # on Windows: .venv\Scripts\activate
python -m pip install -e . --group dev
The framework/ submodule is only needed to work on the project documents; the program and its tests do not use it. Add --recurse-submodules to the clone command if you have access to it.
▶️ Run
python src/hirst_painting.py
A window opens, the painting appears at once, and a click closes it. The image the palette is taken from is the constant REFERENCE_IMAGE_PATH in src/hirst_painting.py.
🧪 Tests
python -m pytest
python -m ruff format --check .
python -m ruff check .
python -m mypy
mypy runs in strict mode. Ten of the 40 test cases need a display for Tk; this was accepted in the review record of the code (RC-006).
📄 License
GNU Affero General Public License v3.0; see LICENSE.
🔗 Links
📎 Appendix: Project documents
The documents a newcomer needs, in reading order.
| Document | What it tells you |
|---|---|
| Business Case | Why the project exists, its scope and success criteria |
| Stakeholder Analysis | Who is involved; the stakeholder IDs used for owners and reviewers |
| Project Plan | The gateways, their schedule and the Go/No-Go decisions |
| Milestones | One document per gateway: Go/No-Go criteria and tasks |
| Review records | One record per review of a document or of the code, against its quality checklist |
| Artifact registry | Where each artifact type lives, the next version, the PO language and domain |
| Framework | The SQA and QC framework this project uses, mounted as a submodule |