Building and Testing¶
Before starting building and testing package set up Developer's Environment first. From here and below we consider the shell's current directory matches the project's root directory.
To test the package build run:
Compiled packages will be available in the
To run the test suit:
All lints are checked as part of GitHub Actions Workflow. You may run lints manually before committing to the project.
To fix formatting errors run:
We recommend setting python code formatting on file saving (Done in VS Code Dev Container out of the box).
Python Code Lints¶
Python Code Static Checks¶
Python Test Code Coverage Check¶
To evaluate code coverage run tests:
To report the coverage after the test run:
To show line-by-line coverage:
dist/coverage/index.html file in your browser.
To rebuild and check documentation run
We recommend using Grammarly service to check documentation for common errors.