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' ;)

Install the latest release from PyPI

$ pip3 install --user -U python-helloworld $ helloworld --help

Install the latest version from the sources:

This project uses Poetry, ensure you have Poetry installed

$ pip3 install --user -U poetry $ pip3 install --user git+https://github.com/essembeh/python-helloworld $ helloworld --help

Install from the source Clone the project

# ensure you have poetry installed $ pip3 install --user -U poetry # clone the repository $ git clone https://github.com/essembeh/python-helloworld $ cd python-helloworld # create the virtualenv $ poetry install # run the app $ poetry run helloworld --help # or $ poetry shell (.venv) $ helloworld --help # to run the tests: $ poetry run pytest tests # to get the coverage $ poetry run pytest --cov=helloworld tests 

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.