Skip to content

Commit 813e92b

Browse files
committed
fixed readme
1 parent 8316caf commit 813e92b

File tree

2 files changed

+19
-24
lines changed

2 files changed

+19
-24
lines changed

README.md

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
# Modern Python Template
22

3-
![Python](https://img.shields.io/badge/python-3.12+-blue.svg)
4-
![uv](https://img.shields.io/badge/uv-package%20manager-4051B5)
5-
![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)
6-
![License](https://img.shields.io/badge/license-MIT-green.svg)
7-
![Tests](https://github.com/yourusername/python-template/workflows/Test/badge.svg)
8-
![Lint](https://github.com/yourusername/python-template/workflows/Lint/badge.svg)
9-
![Type Check](https://github.com/yourusername/python-template/workflows/Type%20Check/badge.svg)
3+
![Python](https://img.shields.io/badge/python-3.12%2B-blue)
4+
![uv](https://img.shields.io/badge/uv-package%20manager-DE5FE9)
5+
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
6+
![License](https://img.shields.io/badge/license-MIT-green)
107

118
A fast, modern Python project template using the latest Rust-based tooling for maximum developer productivity.
129

@@ -148,9 +145,9 @@ def test_your_function():
148145

149146
This template includes GitHub Actions workflows:
150147

151-
- **Lint** (`lint.yaml`) - Fast code style checking
152-
- **Type Check** (`typecheck.yaml`) - Type safety validation
153-
- **Test** (`test.yaml`) - Run your test suite
148+
- **Lint** (`lint.yml`) - Fast code style checking
149+
- **Type Check** (`typecheck.yml`) - Type safety validation
150+
- **Test** (`test.yml`) - Run your test suite
154151

155152
All workflows run on push/PR and provide fast feedback.
156153

@@ -177,20 +174,17 @@ All workflows run on push/PR and provide fast feedback.
177174

178175
### Python Dependencies
179176

180-
Add dependencies to `pyproject.toml`:
177+
Add dependencies using uv:
181178

182-
```toml
183-
[project]
184-
dependencies = [
185-
"requests",
186-
"pydantic",
187-
]
179+
```bash
180+
# Add runtime dependencies
181+
uv add requests pydantic
182+
183+
# Add development dependencies
184+
uv add --dev pytest-xdist black
188185

189-
[dependency-groups]
190-
dev = [
191-
"pytest",
192-
"ruff",
193-
]
186+
# Add optional dependencies
187+
uv add --optional web fastapi uvicorn
194188
```
195189

196190
Then run:

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[project]
2-
name = "python-template"
2+
name = "your-project-name"
33
version = "0.1.0"
4-
description = "Add your description here"
4+
description = "Your project description"
5+
authors = [{name = "Your Name", email = "your.email@example.com"}]
56
readme = "README.md"
67
requires-python = ">=3.12"
78
dependencies = []

0 commit comments

Comments
 (0)