README.md

Atelier_code

FIRST THINGS TO DO ON CREATION (this section should not be seen by anyone on your repo, follow and remove it at the end!!!)

create a conda env with pre-commit installed:

conda create -n Atelier_code python=3.7
conda install -c conda-forge pre-commit pytest coverage #if you are not root, maybe you need to install git and openssh with conda

Once pre-commit installed run:

pre-commit install

Each time you'll commit, a pipeline will run to check your files (pep8 formatting, search for unused code...)

Last step is create an env.yml file in order to fix all python's modules and deps. To do that, you need to run:

conda env export > env.yaml

This file is mandatory for the installation script.

Installation

To create a working env and setup all pre-commit hooks just run the installation script:

sh install.sh

Usage