Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/test.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,11 @@ jobs:
run: |
uv run ruff check --output-format=github .

- name: Test ty Type Check
working-directory: /tmp/test-copier
run: |
uv run --frozen ty check

- name: Test pytest
working-directory: /tmp/test-copier
run: |
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ A simple modern Python project template powered by [Copier](https://copier.readt
- ✨ **AI Editor Support**: [AGENTS.md](https://agents.md) and
[CLAUDE.md](https://docs.anthropic.com/en/docs/claude-code/overview) included for AI-powered development
- 📝 **Type Hints**: Full type annotation support with modern Python features
- 🔎 **Type Checking**: Pre-configured [ty](https://docs.astral.sh/ty/) for static type checking
- 🔍 **Code Quality**: Pre-configured Ruff for linting and formatting
- 🧪 **Testing**: pytest setup with example tests
- 🔧 **Pre-commit Hooks**: Automated code quality checks
Expand DownExpand Up@@ -61,6 +62,8 @@ uv run pytest
# Run formatting and linting (automatically runs on commit)
uv run ruff format .
uv run ruff check .
# Run type checking
uv run --frozen ty check
# Auto Fix
uv run ruff check . --fix
```
Expand DownExpand Up@@ -114,10 +117,13 @@ your-project/

## Q&A

### Why don't you use a type checker?
### How do I run type checking?

I'm waiting for stable release of [`ty`](https://github.com/astral-sh/ty).
You can install and use your preferred type checker.
Run the pre-configured [`ty`](https://docs.astral.sh/ty/) type checker:

```bash
uv run --frozen ty check
```

## Support

Expand Down
3 changes: 3 additions & 0 deletions template/.github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,5 +25,8 @@ jobs:
- name: Lint
run: uv run --frozen ruff check --output-format=github .

- name: Type check
run: uv run --frozen ty check

- name: Test
run: uv run --frozen pytest
2 changes: 1 addition & 1 deletion template/pyproject.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ build-backend = "hatchling.build"
packages = ["src/{{package_name}}"]

[dependency-groups]
dev = ["pre-commit>=4.2.0", "pytest>=8.4.0", "ruff>=0.11.12"]
dev = ["pre-commit>=4.2.0", "pytest>=8.4.0", "ruff>=0.11.12", "ty>=0.0.77"]

[tool.ruff]
line-length = 100
Expand Down
69 changes: 48 additions & 21 deletions template/uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.