Skip to content

Commit 6579710

Browse files
committed
update README.md
1 parent 2bb9a80 commit 6579710

1 file changed

Lines changed: 62 additions & 6 deletions

File tree

README.md

Lines changed: 62 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,34 @@
11
# Python Project Template
22

3-
Modern Python Project
3+
[![CI](https://github.com/mjun0812/python-project-template/actions/workflows/ci.yml/badge.svg)](https://github.com/mjun0812/python-project-template/actions/workflows/ci.yml)
44

5-
## Development Setup
5+
A simple modern Python project template.
66

7-
After generating your project:
7+
This repository is created by [mjun0812/python-copier-template](https://github.com/mjun0812/python-copier-template) using [copier](https://copier.readthedocs.io/).
88

9-
```bash
10-
cd your-project-name
9+
## Features
10+
11+
- 🚀 **Modern Python**: Support for Python 3.10-3.13
12+
- 📦 **uv Package Manager**: Fast and reliable package management with [uv](https://github.com/astral-sh/uv)
13+
- 🐳 **Docker Support**: Complete Docker development environment
14+
- 📦 **Devcontainer Support**: VS Code devcontainer for consistent development
15+
-**AI Editor Support**: [Cursor rules](https://docs.cursor.com/context/rules) and
16+
[CLAUDE.md](https://docs.anthropic.com/en/docs/claude-code/overview) included for AI-powered development
17+
- 📝 **Type Hints**: Full type annotation support with modern Python features
18+
- 🔍 **Code Quality**: Pre-configured Ruff for linting and formatting
19+
- 🧪 **Testing**: pytest setup with example tests
20+
- 🔧 **Pre-commit Hooks**: Automated code quality checks
21+
- 🏗️ **CI Ready**: GitHub Actions workflows included
22+
23+
## Quick Start
24+
25+
### Pre-Requirements
26+
27+
- [uv](https://docs.astral.sh/uv/): Fast Python package installer
1128

29+
### Development Setup
30+
31+
```bash
1232
# Install dependencies
1333
uv sync
1434

@@ -25,7 +45,7 @@ uv run ruff check .
2545
uv run ruff check . --fix
2646
```
2747

28-
### Docker Development
48+
### Docker Development Setup
2949

3050
The template includes a complete Docker setup:
3151

@@ -45,3 +65,39 @@ docker compose up
4565
### VS Code Devcontainer
4666

4767
Open the project in VS Code and use the "Reopen in Container" command for a fully configured development environment.
68+
69+
### Update Template
70+
71+
Thit template is created by [mjun0812/python-copier-template](https://github.com/mjun0812/python-copier-template).
72+
You can apply update from it.
73+
74+
```bash
75+
cd your-project-name
76+
uvx copier update -A
77+
```
78+
79+
## Project Structure
80+
81+
```text
82+
your-project/
83+
├── src/
84+
│ └── your_project/ # Main package
85+
├── tests/ # Test files
86+
├── docker/ # Docker configuration
87+
├── compose.yml # Docker Compose setup
88+
├── pyproject.toml # Project configuration
89+
└── README.md # Project documentation
90+
```
91+
92+
## Q&A
93+
94+
### Why don't you use a type checker?
95+
96+
I'm waiting for stable release of [`ty`](https://github.com/astral-sh/ty).
97+
You can install and use your preferred type checker.
98+
99+
## Support
100+
101+
- 📖 [Copier Documentation](https://copier.readthedocs.io/)
102+
- 🐍 [uv Documentation](https://docs.astral.sh/uv/)
103+
- 🔍 [Ruff Documentation](https://docs.astral.sh/ruff/)

0 commit comments

Comments
 (0)