Skip to content

Commit 9fcb8c6

Browse files
committed
docs: update readme
1 parent d0c1cb6 commit 9fcb8c6

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
# Python Project Template
1+
# Python Python Template
22

33
This is a template for creating Python projects. It includes a basic project structure, configuration files, and setup scripts to help you get started quickly.
44

55
## Features
66

7-
- πŸ“ Pre-configured with `poetry` for dependency management
8-
- πŸͺ› Linting with `ruff`
9-
- πŸ”§ Type checking with `mypy`
10-
- πŸ§ͺ Testing with `pytest`
11-
- πŸ“ Pre-commit hooks for code quality
12-
- πŸ“¦ Uses `dev container` for development setup
7+
- πŸ“ Pre-configured with [uv](https://docs.astral.sh/uv/) for dependency management
8+
- πŸͺ› Linting with [ruff](https://docs.astral.sh/ruff/)
9+
- πŸ”§ Type checking with [mypy](https://mypy-lang.org/)
10+
- πŸ§ͺ Testing with [pytest](https://docs.pytest.org/en/stable/)
11+
- πŸ“ [Pre-commit](https://pre-commit.com/) hooks for code quality
12+
- πŸ“¦ Uses [dev container](https://containers.dev/) development setup
13+
- πŸ”Ž Easy documentation with [MkDocs](https://containers.dev/)
1314

1415
## Getting Started
1516

@@ -31,3 +32,7 @@ This is a template for creating Python projects. It includes a basic project str
3132
- Press `F1` to open the command palette.
3233
- Type `Remote-Containers: Reopen in Container` and select it.
3334
- VS Code will build the Docker container defined in the `.devcontainer` folder and open the project inside the container.
35+
36+
## Additional features
37+
38+
* [Dev Container Feature](https://containers.dev/features)

0 commit comments

Comments
Β (0)