|
1 | | -# Branding |
| 1 | +# Branding — Python Project Template |
2 | 2 |
|
3 | | -All fields are optional. Blank or absent fields fall back to defaults (adjective-animal release names, Mermaid default colors, no wording constraints). Agents read this file before generating release names, C4 diagrams, README banners, or any document with visual or copy identity. |
| 3 | +> *From zero to hero — production-ready Python, without the ceremony.* |
| 4 | +
|
| 5 | +Agents read this file before generating release names, C4 diagrams, README banners, or any document with visual or copy identity. All fields are optional; absent or blank fields fall back to defaults (adjective-animal release names, Mermaid default colors, no wording constraints). |
4 | 6 |
|
5 | 7 | --- |
6 | 8 |
|
7 | 9 | ## Identity |
8 | 10 |
|
9 | 11 | - **Project name:** Python Project Template |
10 | | -- **Tagline:** Production-ready Python, from zero to workflow in minutes. |
| 12 | +- **Tagline:** From zero to hero — production-ready Python, without the ceremony. |
11 | 13 | - **Mission:** Eliminate boilerplate so engineers ship features, not setup. |
12 | | -- **Vision:** The standard starting point for any serious Python project. |
13 | | -- **Tone of voice:** Direct, precise, minimal. No fluff. |
| 14 | +- **Vision:** The standard starting point for any serious Python project — the bedrock every Python engineer reaches for first. |
| 15 | +- **Tone of voice:** Direct, precise, minimal. The Greeks did not decorate the Parthenon with apologies. Neither do we. |
14 | 16 |
|
15 | 17 | ## Visual |
16 | 18 |
|
17 | | -- **Background/parchment:** `#faf7f2` → `#ede8e0` — warm off-white marble (primary surface) |
18 | | -- **Primary text:** `#5c3d1e` → `#3b2410` — deep warm brown (body text, headings) |
19 | | -- **Accent/gold:** `#c9a84c` → `#e8c96a` — antique gold (borders, highlights, lines) |
20 | | -- **Secondary/blue:** `#7baabf` → `#4a7a96` — muted steel blue (labels, secondary text) |
21 | | -- **Stone/marble:** `#f0ece4` → `#c8c0b8` — structural marble tone (temple columns, shapes) |
| 19 | +The palette is drawn from classical marble, parchment, and gold — materials that have carried ideas for millennia. Every colour choice serves legibility first; decoration is secondary. |
| 20 | + |
| 21 | +- **Background/parchment:** `#faf7f2` → `#ede8e0` — warm off-white, the surface on which ideas are set down |
| 22 | +- **Primary text:** `#5c3d1e` → `#3b2410` — deep warm brown, the ink that endures |
| 23 | +- **Accent/gold:** `#c9a84c` → `#e8c96a` — antique gold, used for borders and structural lines only — never body text |
| 24 | +- **Secondary/blue:** `#7baabf` → `#4a7a96` — Aegean steel blue, for labels and secondary hierarchy |
| 25 | +- **Stone/marble:** `#f0ece4` → `#c8c0b8` — the load-bearing colour; columns, shapes, structural chrome |
22 | 26 | - **Logo:** `docs/assets/logo.svg` |
23 | 27 | - **Banner:** `docs/assets/banner.svg` |
24 | 28 |
|
25 | | -> Color system derived from the SVG assets (classical Greek temple aesthetic — marble, parchment, antique gold). Deep brown `#3b2410` on parchment `#faf7f2` achieves > 10:1 contrast (WCAG AAA). Gold accent used for decorative lines and borders only, not body text. |
| 29 | +> Deep brown `#3b2410` on parchment `#faf7f2` achieves >10:1 contrast (WCAG AAA). Gold is decorative; it never carries meaning that must be read. |
26 | 30 |
|
27 | 31 | ## Release Naming |
28 | 32 |
|
29 | 33 | - **Convention:** `adjective-greek-figure` |
30 | | -- **Theme:** Greek antiquity — philosophers, heroes, gods, mythological figures (e.g. "Nimble Socrates", "Resolute Athena", "Precise Pythagoras") |
| 34 | +- **Theme:** Greek antiquity — philosophers, heroes, gods, mythological figures. Every release name should read like an epithet: something a figure *earned* through their defining quality (e.g. "Resolute Athena", "Precise Pythagoras", "Luminous Hypatia"). |
| 35 | +- **Rationale:** Ancient Greece is the origin of the intellectual tradition that underpins Western civilisation — democracy, systematic philosophy, formal logic, and scientific reasoning all trace their lineage to the Greek city-states. Plato and Aristotle invented political philosophy as a genre; Aristotle formalised logic and ethics; the Pythagoreans established that abstract reasoning could describe the physical world. This template stands on the same premise: rigorous method, applied from the beginning, produces something worth building on. The Greek figure in each release name is not decoration — it is a statement about what kind of work this is. |
31 | 36 | - **Excluded words:** *(none)* |
32 | 37 |
|
33 | 38 | ## Wording |
34 | 39 |
|
35 | | -- **Avoid:** `easy`, `simple`, `just`, `quick` — these undermine engineer credibility |
36 | | -- **Prefer:** `minimal`, `precise`, `production-ready`, `zero-boilerplate` |
| 40 | +Every word carries weight. The Greeks had a name for ornament that obscures meaning: *kenophonia* — empty noise. |
| 41 | + |
| 42 | +- **Avoid:** `easy`, `simple`, `just`, `quick`, `scaffold` — these words undermine engineer credibility or imply the work is trivial. A temple is not a scaffold. |
| 43 | +- **Prefer:** `minimal`, `precise`, `production-ready`, `zero-boilerplate`, `rigorous`, `from zero to hero` |
37 | 44 |
|
38 | 45 | ## Project Summary |
39 | 46 |
|
40 | 47 | A Python project template with a production-ready AI-assisted delivery workflow. |
41 | 48 | Ships with quality tooling (ruff, pyright, pytest, hypothesis), Gherkin-driven |
42 | | -acceptance criteria, and four specialized AI agents covering scope through release. |
43 | | -Use this summary in banners, release notes, and document headers. |
| 49 | +acceptance criteria, and five specialised AI agents covering scope through release. |
| 50 | +Built on the premise that rigorous method, applied from the beginning, produces |
| 51 | +something worth building on. Use this summary in banners, release notes, and document headers. |
0 commit comments