* When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features
* When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features
* Use make commands to check the code and the format it correct.
* Use make commands to check the code and the format.
Black, the formatting tool, requires Python 3.6 or higher.
Black, the formatting tool, requires Python 3.6 or higher.
...
@@ -74,11 +74,11 @@ poetry install --no-dev
...
@@ -74,11 +74,11 @@ poetry install --no-dev
poetry run python examples/request_data.py
poetry run python examples/request_data.py
```
```
* Before submiting a merge requests, please check the static typing and tests.
* Before submitting a merge requests, please check the static typing and tests.
* Install dev dependencies
* Install dev dependencies
```bash
```bash
poetry instal
poetry install
```
```
* Check static typing with [mypy](http://mypy-lang.org/)
* Check static typing with [mypy](http://mypy-lang.org/)
...
@@ -105,7 +105,7 @@ Change and commit and tag the new version number (semantic version number)
...
@@ -105,7 +105,7 @@ Change and commit and tag the new version number (semantic version number)
Build the PyPi package in the `dist` folder
Build the PyPi package in the `dist` folder
```bash
```bash
Noetry build
poetry build
```
```
Deploy the package to PyPi test repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)
Deploy the package to PyPi test repository (prefix the command with a space in order for the shell not to save in its history system the command containing the password)