Fix documentation inconsistencies and bump document versions

This commit is contained in:
Jan Doubravský
2026-08-18 12:22:57 +02:00
parent 5c0f2f758f
commit b337da11a6
17 changed files with 170 additions and 27 deletions
+14 -5
View File
@@ -8,12 +8,15 @@ Create a `template/` folder in project root with reusable files for new Python p
template/
├── .env # Environment variables (sample)
├── .gitignore # Git ignore rules
├── AGENTS.md # AI assistant rules
├── CHANGELOG.md # Changelog template
├── DESIGN_DOCUMENT.md # Development guidelines
├── PROJECT.md # Project documentation template
├── main.py # Entry point with loguru
├── README.md # Project overview, tool descriptions, build instructions
├── <tool_name>.py # Entry point — named by purpose or tool name
├── <tool_name>.spec # PyInstaller spec (only for projects shipping an .exe)
├── prebuild.py # Pre-build script: venv check, version print, console= rewrite
├── pyproject.toml # Poetry config (ruff, mypy, pytest)
├── docs/
│ └── .gitkeep # Detailed documentation lives here, never in the root
├── src/
│ ├── __init__.py
│ ├── _version.py # Version fallback for PyInstaller
@@ -23,12 +26,16 @@ template/
└── test_constants.py # Basic test
```
`AGENTS.md` and `DESIGN_DOCUMENT.md` are **not** part of the template — they are copied
into the project root from the documentation repository and are never committed.
## Key Features
- **Version extraction** from `pyproject.toml` with `_version.py` fallback for PyInstaller builds
- **DEBUG mode** via `ENV_DEBUG=true` in `.env` (adds "DEV" suffix to version: v1.2.3DEV)
- **loguru** for logging (never print)
- **Poetry** for dependency management
- **Build configuration** via `ENV_BUILD_CONSOLE` and `ENV_BUILD_SPEC` in `.env`, applied by `prebuild.py`
- **loguru** for logging (never print for debugging)
- **Poetry** for dependency management, `poetry.lock` committed
- **pytest** for testing (no unittest)
- **ruff + mypy** for linting and type checking (120-character lines)
@@ -38,3 +45,5 @@ template/
- Generic/reusable format
- Keep files simple and minimal
- `.gitignore` is the shared core from `Project template/.gitignore` with `Python/.gitignore` appended
- Entry point is named by purpose or tool name — a project may have several
- `prebuild.py` and the `.spec` file are only needed for projects distributed as a standalone `.exe`