-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.md.jinja
More file actions
56 lines (44 loc) · 1 KB
/
README.md.jinja
File metadata and controls
56 lines (44 loc) · 1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# {{project_name}}
{{project_description}}
Project scaffolded from `copier` template.
## Installation
Install dependencies:
```bash
make install
```
## Usage
Run the application:
```bash
uv run python -m {{project_name}}
```
## Development
{% if "pytest" in dev_deps %}
### Running Tests
```bash
make test-unit
```
{% endif %}
{% if "ruff" in dev_deps %}
### Code Quality
```bash
make lint
make format
```
{% endif %}
## Project Structure
```
src/{{project_name}}/ # Main package
{%- if "pytest" in dev_deps %}
tests/unit/ # Unit tests
{%- endif %}
```
## Notes
This project was generated using the copier template. To refresh with upstream improvements later run:
```bash
copier update
```
Do not manually edit the `.copier-answers.yml` file (it is auto-maintained by Copier).
To re-create this project non-interactively from the template in a new location you can prepare a data file with the needed keys and run:
```bash
copier copy --data-file path/to/data.yml /path/to/template /new/dest
```