mononoki/pyproj
Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

debug)

Browse Source
This commit is contained in:
FoxVoland
2026-09-16 20:22:37 +03:00
parent 762f36beab
commit 82d0fb8ca9
1 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -4,20 +4,28 @@ ${REPO_DESCRIPTION}
## Requirements ## Requirements
Required Python version is specified in `.python-version`. Required Python version is specified in `.py-version` (currently Python 3.11).
Install application dependencies: Install application dependencies:
```bash ```bash
python -m pip install -r requirements.txt python -m pip install -r req.txt
``` ```
Install development dependencies: Install development dependencies:
```bash ```bash
python -m pip install -r requirements-dev.txt 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 ## Tests
Run all tests: Run all tests:
@@ -28,8 +36,6 @@ python -m pytest
Tests are also executed automatically for Pull Requests targeting `main`. Tests are also executed automatically for Pull Requests targeting `main`.
A Pull Request must pass automated tests before it can be merged.
## Docker ## Docker
Docker images are built automatically: Docker images are built automatically:
@@ -37,11 +43,9 @@ Docker images are built automatically:
- when changes are pushed to the `deploy` branch; - when changes are pushed to the `deploy` branch;
- when a version tag matching `v*.*.*` is created. - when a version tag matching `v*.*.*` is created.
The Python version used for Docker builds is taken from `.python-version`.
## Project structure ## Project structure
```text ```text
src/ Application source code src/ Application source code
tests/ Automated tests tests/ Add automated tests here
``` ```