JP & TF: pre-commit

[fel-thomas]

Summary

I'm taking @justinplakoo PR in order to try to detail and split the code so that we can discuss about pre-commit.

This pull request is to introduce the pre-commit mechanism. The goal is simple: once installed, it will make minor fixes for you before committing. I added the dependency in the requirement_dev and it will be enough to install it with a pip install.

For more information: Pre-commit.

Introduction of Pre-commit

In details now, pre-commit are defined as hooks in the pre-commit-config.yaml file. The hooks that are introduced for the moment are:

• trailing whitespace (4b1e357) which simply remove all the bad whitespace
• large files (0602a4a) which prevent us to commit large file by mistake
• ast (b350164) which check whether files parse as valid python
• docstring first (5487d86) which check a common error of placing code before the docstring
• merge conflict (af17b3f) which look for merge conflict and prevent us to commit them
• final newline (4373d0f) which ensure we have a final newline at the end of each file

Finally, we run those checks once in (f509dac).
🙏 I apologize in advance for all the files affected. I took the liberty of checking all the files one by one to make sure there were no aberrations but a second pair of eyes on this commit would not be too much.

These hooks are automatically triggered during the commits. In case you want to trigger them by hand, @justinplakoo has put a specific command in the makefile: make pc_check.

Copyright & Governance

On another note, the governance file made by @justinplakoo is introduced, the existing MIT license where the copyright was in my name is now on the IRT / DEEL / UPS / ANITI (3e77029).

Proposition

I think we should add the pre-commit in the test CI ? What do you think ? If you agree I can prepare another PR to add it.

[AntoninPoche]

There seems to be no aberration in the white space cleaning and final line adding.

[lucashervier]

Nothing to declare

[justinplakoo]

Everything is good for me