- Notifications
You must be signed in to change notification settings - Fork5
A python boilerplate project using poetry and ruff
License
marcieltorres/python-boilerplate-project
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
A python boilerplate project using poetry
- Python 3.11 -pre-requisite
- Docker -pre-requisite
- Docker Compose -pre-requisite
- Poetry -pre-requisite
- Ruff
Please pay attention onpre-requisites resources that you must install/configure.
Use this section to explain each env variable available on your application
Variable | Description | Available Values | Default Value | Required |
---|---|---|---|---|
ENV | The application enviroment | dev / test / qa / prod | dev | Yes |
PYTHONPATH | Provides guidance to the Python interpreter about where to find libraries and applications | ref | . | Yes |
Note: When you run the install command (using docker or locally), a .env file will be created automatically based onenv.template
Command | Docker | Locally | Description |
---|---|---|---|
install | make docker/install | make local/install | to install |
tests | make docker/tests | make local/tests | to run the tests with coverage |
lint | make docker/lint | make local/lint | to run static code analysis using ruff |
lint/fix | make docker/lint/fix | make local/lint/fix | to fix files using ruff |
run | make docker/run | make local/run | to run the project |
build image | make docker/image/build | - | to build the docker image |
push image | make docker/image/push | - | to push the docker image |
Helpful commands
Please, check all available commands in theMakefile for more information.
This project uses a simple way to configure the log withlogging.conf to show the logs on the container output console.
This project uses a simple way to manage the settings withsettings.conf andConfigParser using aconfig class.
About
A python boilerplate project using poetry and ruff
Topics
Resources
License
Code of conduct
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.
Contributors3
Uh oh!
There was an error while loading.Please reload this page.