Skip to content

Commit cb67792

Browse files
committed
chore: Add status badges and update readme with emoji
1 parent 5df54a8 commit cb67792

1 file changed

Lines changed: 27 additions & 12 deletions

File tree

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
1-
# Python Project Template
1+
<div align="center">
2+
3+
[![tests](https://github.com/patryk-gpl/copier-python-uv/actions/workflows/test.yml/badge.svg)](https://github.com/patryk-gpl/copier-python-uv/actions)
4+
[![Python versions](https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12%20|%203.13-blue)](https://python.org)
5+
[![uv](https://img.shields.io/badge/uv-enabled-blue)](https://docs.astral.sh/uv/)
6+
[![ruff](https://img.shields.io/badge/ruff-enabled-black)](https://docs.astral.sh/ruff/)
7+
[![copier](https://img.shields.io/badge/copier-template-orange)](https://copier.readthedocs.io/)
8+
[![License](https://img.shields.io/github/license/patryk-gpl/copier-python-uv)](LICENSE)
9+
10+
# 🎯 Python Project Template
11+
12+
213

314
This template provides a standardized Python project structure with sensible defaults, tailored to use in Python projects. It streamlines project setup and encourages best practices from the start.
415

5-
# Prerequisites
16+
</div>
17+
18+
---
19+
20+
## 📋 Prerequisites
621

722
The following tools must be installed:
8-
- Python 3.9 or newer
23+
- Python 3.10 or newer
924
- uv or pipx (if you want to install Copier in an isolated environment, accessible everywhere)
1025
- copier
1126

12-
## Usage
27+
## 🚀 Usage
1328

1429
1. **Install Copier** (if not already):
1530
```bash
@@ -48,13 +63,13 @@ The following tools must be installed:
4863
git commit -m "feat: Bootstrap repository from template"
4964
```
5065

51-
### Answers Files Explained
66+
### 📦 Answers Files Explained
5267
| File | Purpose |
5368
|------|---------|
5469
| `.copier-answers.yml` | Auto-maintained answers file for future updates (never edit manually). Now explicitly generated because the template includes `.copier-answers.yml.jinja`. |
5570
| `samples/config-basic.yml` | Example data file passed with `--data-file` (excluded from rendered projects). |
5671

57-
### Internal Template Artifacts Not Copied
72+
### ⚙️ Internal Template Artifacts Not Copied
5873
The template excludes helper folders (`samples/`, `my_tests/`) from generated projects via `_exclude` in `copier.yaml`. This keeps consumer projects clean.
5974

6075
To create a new variant template from existing data file configuration:
@@ -63,29 +78,29 @@ copier copy --data-file /path/to/config-basic.yml /path/to/template /dest
6378
```
6479
For advanced configuration (tasks, migrations, multiple templates) see the Copier docs sections: tasks, migrations, applying multiple templates.
6580

66-
## Customization
81+
## ✏️ Customization
6782

6883
You can edit the template files (`*.jinja`) to fit your team's standards. See [Copier documentation](https://copier.readthedocs.io/en/stable/) for advanced templating and options.
6984

70-
## Testing the Template
85+
## 🧪 Testing the Template
7186

7287
This template includes comprehensive validation tests to ensure generated projects meet expected standards.
7388

74-
### Running Tests
89+
### ▶️ Running Tests
7590

7691
```bash
7792
# Run all validation tests
7893
make test
7994
```
8095

81-
### Test Performance
96+
### Test Performance
8297

8398
Tests use session-scoped fixtures for optimal performance:
8499
- **Session-scoped fixtures:** Generated projects created once per test session, reused across all test modules
85100
- **Module-scoped wrappers:** Clean test API with ~50% faster execution vs module scope alone
86101
- **All tests read-only:** No mutations to generated projects ensures fixture reuse is safe
87102

88-
### Test Files
103+
### 📁 Test Files
89104

90105
Test files are located in `my_tests/` folder.
91106

@@ -97,6 +112,6 @@ Test files are located in `my_tests/` folder.
97112

98113
See `my_tests/conftest.py` for fixture definitions.
99114

100-
## References
115+
## 📚 References
101116
- [Copier Documentation](https://copier.readthedocs.io/en/stable/)
102117
- [pre-commit](https://pre-commit.com/)

0 commit comments

Comments
 (0)