Skip to content

Commit e284b9b

Browse files
committed
chore: update README.md
1 parent 0d86780 commit e284b9b

1 file changed

Lines changed: 18 additions & 5 deletions

File tree

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,25 @@ Minimal template for a quick start of a Python project.
1818
- **[Labeler](https://github.com/actions/labeler)** to auto-apply labels to PRs
1919
- **[Mypy](https://mypy-lang.org/)** for static typing + **[Ruff](https://docs.astral.sh/ruff/)** for lint/format
2020
- **[pre-commit](https://pre-commit.com/)** for local hooks before commits
21+
- **docker-compose** out of the box
22+
- **[structlog](https://www.structlog.org/)** logger included by default
23+
2124

2225
## Commands
26+
27+
```
28+
just rename aboba # set the project name across the repo
29+
just install # install python dependencies via uv
30+
just lint # run formatting and lint checks
31+
just test # run tests via pytest with coverage
32+
just run # run the application
33+
just up # run the application via docker compose
34+
just down # stop the application via docker compose
2335
```
24-
just rename aboba # set the project name across the repo
25-
just install # install python dependencies via uv
26-
just lint # run formatting and lint checks
27-
just test # run tests via pytest with coverage
28-
just run # run the application
36+
37+
## Configuring
38+
39+
```sh
40+
cp config/template.config.yaml config/config.yaml
41+
cp config/template.env config/.env
2942
```

0 commit comments

Comments
 (0)