This is just a sample helloworld project which aims to provide some good (at least not so bad) praticies to start a new project.

Basically, you can clone this repository and run sed -i 's/helloworld/YOURPROJECTNAME/g' ;)

This project uses Poetry, ensure you have Poetry installed

$ pip3 install --user -U poetry

Clone the project

$ git clone https://github.com/essembeh/python-helloworld $ cd python-helloworld

To setup the virtualenv:

$ poetry install # to install app with dev dependencies $ poetry install --no-dev # to install app without dev depdencies $ poetry shell (venv) $ helloworld --help

To run the app:

$ poetry run helloworld --help

To run the tests:

$ poetry run pytest tests $ poetry run pytest --cov=helloworld tests # To get the coverage

Poetry, a very useful tool to avoid boilerplate code (setup.py, requirements.txt, requirements-dev.txt ...)

VSCodium: a light IDE editor supporting Python with an extension. Some workspace settings in .vscode/settings.json are configured for example to work with the virtual environment.

Pylint: to report many warnings/errors (and VSCodium is configured to show them).

Black: a strict code formatter that automatically format source code on save using VSCodium.