Skip to content

Commit 26fef82

Browse files
committed
feat: README.md
1 parent db9c31d commit 26fef82

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# `uv` Python Template
2+
3+
An alternative to the `poetry` template found [here](https://github.com/idatsy/python-base), with minimal defaults:
4+
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
10+
11+
> Run `make help` for a list of available commands.
12+
13+
## Usage
14+
15+
Clone the repo as a template, then find and replace `python-base-uv`, and you're good to go!
16+

0 commit comments

Comments
 (0)