File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11# ` uv ` Python Template
22
3- An alternative to the ` poetry ` template found [ here ] ( https://github.com/idatsy/python-base ) , with minimal defaults:
3+ Modern Python project template using [ uv ] ( https://docs.astral.sh/uv/ ) for easy dependency management.
44
5- * Test suite using ` pytest ` with ` pytest-asyncio ` and ` pytest-watcher ` for TDD
6- * ` loguru ` as the default logging solution
7- * ` ruff ` and ` pyright ` configurations for formatting, with strict rules enabled by default to enforce strict typing and correctness
8- * Default GitHub Actions requiring formatting, linting, and passing tests before merges into ` main `
9- * Makefile with shorthand commands for common tasks
5+ Alternative using ` poetry ` found [ here] ( https://github.com/idatsy/python-base ) .
106
11- > Run ` make help ` for a list of available commands.
7+ ## Features
8+
9+ * ` pytest ` with ` pytest-asyncio ` and ` pytest-watcher ` for TDD
10+ * ` loguru ` for logging
11+ * ` ruff ` and ` pyright ` for linting, formatting, and type checking (with strict defaults!)
12+ * GitHub Actions CI
1213
1314## Usage
1415
15- Clone the repo as a template, then find and replace ` python-base-uv ` , and you're good to go!
16+ - Clone the repo
17+ - Find/replace ` python-base-uv ` with your project name
18+ - Or ask copilot to change all template references as the initial commit!
19+
20+ ** Makefile**
21+ - ` make sync ` to update dependencies.
22+ - ` make check ` before committing (runs ruff and pyright)
23+ - ` make test ` to run tests.
24+ - ` make watch ` for TDD mode (auto-run tests on save).
25+ - ` make help ` for all commands.
1626
27+ > Prefix files with ` wip_ ` to skip linting.
You can’t perform that action at this time.
0 commit comments