| ... | ... | @@ -31,12 +31,14 @@ So I guess it's okay if we have a few guidelines. The [Google Python Style Guide |
|
|
|
- Follow the "Google Style" for docstrings (reStructuredText format).
|
|
|
|
|
|
|
|
# Testing
|
|
|
|
As much as possible, we should write automatic tests for our code using `pytest`.
|
|
|
|
Use pip to get it: `pip install pytest`
|
|
|
|
|
|
|
|
Tests should be located in a `tests` directory, at the root of your repository. In this directory, create a file for each module of your package, name following the convention `test_modulename.py`.
|
|
|
|
To ensure high code quality, it is highly recommended to incorporate automated tests using `pytest`.
|
|
|
|
|
|
|
|
For example, your project structure could be like this:
|
|
|
|
You can easily install `pytest` by running the following command: `pip install pytest`.
|
|
|
|
|
|
|
|
Organize your tests within a dedicated directory named `tests`, positioned at the root level of your repository. Within this directory, create a separate file for each module in your package, adhering to the naming convention `test_modulename.py`.
|
|
|
|
|
|
|
|
For instance, a suggested project structure could be the following:
|
|
|
|
|
|
|
|
```
|
|
|
|
example-repo/
|
| ... | ... | |
| ... | ... | |