This is a simple python project which intends to be a a python getting start template
# Installing Python
sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa -y
sudo apt update
sudo apt install python3.9 -y
python3.9 --version
# Installing Python Env and Pip
sudo apt install python3.9-venv python3-pip -yThis enables a project sandbox, containing only the packages really needed, and ignoring all the Python packages installed elsewhere on your system. Conventionally, the virtual environment is called venv.
python3.9 -m venv venv
source venv/bin/activateAfter that, it is not necessary to specify python version when running python commands, because all python configuration is setup in your virtual environment
In order to deactivate the python environment use the following command:
deactivateAll python dependencies are specified at the requirements file, and it is possible to install them using pip
# Development Dependencies
pip install -r requirements-dev.txt
# Production Dependencies
pip install -r requirements.txtTo execute the application, just run the following command:
# console (development mode)
python -m app
# gunicorn (production mode)
gunicorn -c gunicorn.conf.py wsgy:app
# docker
docker build -t python-template .
docker container run -d -p 5000:5000 python-templateAPI Calls Examples
# HealthCheck (/health/)
curl --location --request GET 'http://localhost:5000/health'
# Add Person (/people/)
curl --location --request POST 'http://localhost:5000/people/' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 211,
"firstName": "Tiago",
"lastName": "Missão",
"age": 28,
"gender": "M"
}'
# Get Person (/people/<id>)
curl --location --request GET 'http://localhost:5000/people/211'
# Get People (/people/list)
curl --location --request GET 'http://localhost:5000/people/list'
# Update Person Specific Fields (/people/<id>)
curl --location --request PATCH 'http://localhost:5000/people/211' \
--header 'Content-Type: application/json' \
--data-raw '{
"firstName": "Tiago Emanuel",
"occupation": "Software Engineer"
}'
# Replace Person (/people/<id>)
curl --location --request PUT 'http://localhost:5000/people/211' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 211,
"firstName": "Tiago",
"lastName": "Missão",
"age": 28,
"gender": "M",
"occupation": "DevOps Engineer"
}'
# Delete Person (/people/<id>)
curl --location --request DELETE 'http://127.0.0.1:5000/people/211'To Execute the lint, run the below commands:
flake8 .
pylint **/*.pyThe lint Flake8 could be configured editing the .flake8 file, and the lint PyLint could be configured editing the .pylintrc file
This project utilizes the PyTest framework in order to run tests, this framework is configured editing the .pytest.ini file. Also pytest-cov library is configured to create the coverage report, which could be configured through .coveragerc file
# execute all tests
pytest
# execute test with a specific mark #pylist.mark.<specif-mark>
pytest -m fibonacci -vTo a test be analyzed it is necessary the file name be test_*py or *_test.py, also the function name should start with the prefix test_*
The coverage could be generated using this command:
# pytest --cov=<package-to-be-analyzed> --cov-report xml:coverage.xml
pytest --cov=app --cov-report xml:coverage.xml