Skip to content

Commit c757e28

Browse files
committed
docs(readme): tighten project positioning
Make the README sound more like a real starter and less like a template pitch.
1 parent 7f226f3 commit c757e28

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
# python-template
22

3-
A minimal Python template with strict defaults for projects that want to stay small, typed, and
4-
easy to maintain.
3+
A small Python starter with strict defaults, fast feedback, and a package layout that scales past
4+
the first weekend.
55

6-
## What this template includes
6+
The goal is simple: start from a clean baseline, keep the toolchain boring, and make quality checks
7+
cheap enough to run all the time.
8+
9+
## Defaults
710

811
- `uv` for dependency and lockfile management
9-
- `src/` layout with Hatchling-based packaging
10-
- Click-powered CLI entry point
11-
- Ruff, Pyright, and pytest configured as the default quality bar
12-
- GitHub Actions for CI, build validation, and tag-based release artifacts
12+
- `src/` layout with Hatchling packaging
13+
- Click for a minimal CLI entry point
14+
- Ruff, Pyright, and pytest as the default quality bar
15+
- GitHub Actions for CI, build validation, and release artifacts
1316

1417
## Quickstart
1518

1619
```bash
17-
uv sync --group dev
20+
make setup-dev
1821
make check
1922
python -m python_template --help
2023
```
@@ -51,19 +54,19 @@ python -m python_template --help
5154

5255
## Quality defaults
5356

54-
This template is intentionally strict:
57+
This template is intentionally strict by default:
5558

5659
- **Ruff** enforces formatting, imports, docstrings, naming, typing hygiene, and common bug-prone
5760
patterns.
5861
- **Pyright** runs in `strict` mode.
5962
- **pytest** is the default regression layer.
6063

61-
The goal is to start from a clean baseline and relax rules only when a real project constraint
62-
demands it.
64+
If a real project constraint justifies relaxing a rule, change it deliberately. The default posture
65+
is to keep the baseline tight.
6366

6467
## GitHub Actions
6568

66-
The repository ships with three small workflows:
69+
The repository ships with three focused workflows:
6770

6871
- `ci.yml` — lint, typecheck, and test on Python 3.11–3.13
6972
- `build.yml` — build the package and smoke-test the generated wheel

0 commit comments

Comments
 (0)