Getting started

You need Python 3 (preferably 3.8) installed to start working on this project.

In order to install your virtualenv, just go to the root of the project and:

make install

IDE

Nuage recommends Visual Studio Code to work on this project, and some default settings have been configured in the .vscode/settings.json.

These settings merely enforce the code-quality guidelines defined below, but if you use another IDE it's probably worth taking a quick look at it to ensure compliance with the standard.

By default, we recommend:

1. Putting your virtualenv in a venv folder at the project root
2. Using a .env file to define your environment variables (cf. python-dotenv)

Code quality

This project has opinionated code-quality requirements:

• Code formatter: black
• Code linter: pylint
• Code style guidelines: flake8

All of these tools are enforced at the commit-level via pre-commit

You can run the following command to apply code-quality to your project at any point:

make quality

Code quality configuration files:

• IDE-agnostic coding style settings are set in the .editorconfig file
• Python-related settings are set in the setup.cfg file
• Pre-commit-related settings are set in the .pre-commit-config.yaml file