52 lines
839 B
Markdown
52 lines
839 B
Markdown
# ${REPO_NAME}
|
|
|
|
${REPO_DESCRIPTION}
|
|
|
|
## Requirements
|
|
|
|
Required Python version is specified in `.py-version` (currently Python 3.11).
|
|
|
|
Install application dependencies:
|
|
|
|
```bash
|
|
python -m pip install -r req.txt
|
|
```
|
|
|
|
Install development dependencies:
|
|
|
|
```bash
|
|
python -m pip install -r req-dev.txt
|
|
```
|
|
|
|
Run the application:
|
|
|
|
```bash
|
|
python src/main.py
|
|
```
|
|
|
|
`src/main.py` is initially empty. Add application logic before using the image as a service.
|
|
|
|
## Tests
|
|
|
|
Run all tests:
|
|
|
|
```bash
|
|
python -m pytest
|
|
```
|
|
|
|
Tests are also executed automatically for Pull Requests targeting `main`.
|
|
|
|
## Docker
|
|
|
|
Docker images are built automatically:
|
|
|
|
- when changes are pushed to the `deploy` branch;
|
|
- when a version tag matching `v*.*.*` is created.
|
|
|
|
## Project structure
|
|
|
|
```text
|
|
src/ Application source code
|
|
tests/ Add automated tests here
|
|
```
|