-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md.jinja
64 lines (42 loc) · 3.08 KB
/
README.md.jinja
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
57
58
59
60
61
62
63
64
# {{ project_name }}
[![Build](https://{{ repository_provider }}/{{ repository_namespace }}/{{ repository_name }}/actions/workflows/build.yaml/badge.svg)](https://{{ repository_provider }}/{{ repository_namespace }}/{{ repository_name }}/actions/workflows/build.yaml){% if include_docs %}
[![Documentation](https://{{ repository_provider }}/{{ repository_namespace }}/{{ repository_name }}/actions/workflows/docs.yaml/badge.svg)](https://{{ repository_provider }}/{{ repository_namespace }}/{{ repository_name }}/actions/workflows/docs.yaml)
{% if docs_library == "mkdocs" %}[![Docs with MkDocs](https://img.shields.io/badge/MkDocs-docs?style=flat&logo=materialformkdocs&logoColor=white&color=%23526CFE)](https://squidfunk.github.io/mkdocs-material/){% elif docs_library == "sphinx" %}[![Docs with Sphinx](https://img.shields.io/badge/Sphinx-docs?style=flat&logo=sphinx&logoColor=white&color=%230A507A)](https://www.sphinx-doc.org/en/master/){% endif %}{% endif %}
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
[![linting: 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){% if use_precommit %}
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](.pre-commit-config.yaml){% endif %}
[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://{{ repository_provider }}/{{ repository_namespace }}/{{ repository_name }}/releases)
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-border.json)](https://github.com/copier-org/copier)
{% if copyright_license == "GNU GPLv3" %}[![License](https://img.shields.io/badge/license-GPLv3-blue)](LICENSE){% elif copyright_license == "MIT" %}[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE){% endif %}
{{ project_description }}
## Features
- `...`
## Installation
With `pip`:
```bash
python -m pip install {{ python_package_distribution_name }}
```
With [`poetry`](https://python-poetry.org/):
```bash
poetry add {{ python_package_distribution_name }}
```
## How to use it
```python
import {{ python_package_import_name }}
...
```
{% if include_docs %}## Docs
{% if docs_library == "sphinx" %}```bash
poetry run sphinx-build -nWv --keep-going -b html ./docs/ ./docs/_build/
```{% endif %}{% if docs_library == "mkdocs" %}```bash
poetry run mkdocs build -f ./docs/mkdocs.yml -d ./_build/
```
{% endif %}{% endif %}
## Update template
```bash
copier update --trust
```
## Credits
This project was generated with [![🚀 A generic python project template.](https://img.shields.io/badge/python--project--template-%F0%9F%9A%80-brightgreen)](https://github.com/twsl/python-project-template)