47 lines
822 B
Markdown
47 lines
822 B
Markdown
# ${REPO_NAME}
|
|
|
|
${REPO_DESCRIPTION}
|
|
|
|
## Requirements
|
|
|
|
Required Python version is specified in `.python-version`.
|
|
|
|
Install application dependencies:
|
|
|
|
```bash
|
|
python -m pip install -r requirements.txt
|
|
```
|
|
|
|
Install development dependencies:
|
|
|
|
```bash
|
|
python -m pip install -r requirements-dev.txt
|
|
```
|
|
|
|
## Tests
|
|
|
|
Run all tests:
|
|
|
|
```bash
|
|
python -m pytest
|
|
```
|
|
|
|
Tests are also executed automatically for Pull Requests targeting `main`.
|
|
|
|
A Pull Request must pass automated tests before it can be merged.
|
|
|
|
## Docker
|
|
|
|
Docker images are built automatically:
|
|
|
|
- when changes are pushed to the `deploy` branch;
|
|
- when a version tag matching `v*.*.*` is created.
|
|
|
|
The Python version used for Docker builds is taken from `.python-version`.
|
|
|
|
## Project structure
|
|
|
|
```text
|
|
src/ Application source code
|
|
tests/ Automated tests
|
|
``` |