conda install --file requirements-dev.txt
This project follows the PEP8 style guide. You can use flake8/black for linting and formatting.
We have defined a couple of rules to ignore.
In .vscode
directory, add the following in your settings.json
file :
{
"python.linting.flake8Enabled": true,
"python.linting.enabled": true,
"python.linting.flake8Args": [
"--ignore=E501"
],
"python.testing.pytestArgs": [
"."
],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true
}
This project follows Google styleguides : https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood in the subject line ("Add the thing", not "Adds the thing")
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Separate subject from body with a blank line
- Do not put references to issues in the subject, but at the bottom of the body
make build
make check_build
make remove_build
mkdocs serve
mkdocs build