Standard Tools

This projects uses the pylint and coverage modules to ensure a decent level of code quality. Both module are configured through their rc files at the root of the project folder. The test coverage is itself dependent on the pytest module. Continuous integration through https://travis-ci.org and https://codecov.io is also pre-configured and discussed in another chapter (Travis & Codecov configuration). The documentation itself is built using sphinx with the autodoc extension. A direct connection to https://readthedocs.io is ready to be established.

• Code Coverage based on Unit Tests
  • Coverage Makefile Targets
  • Uploading to Codecov.io
  • Codecoverage as a Check in GitHub
  • Discussion on Coverage Targets
    • The app
    • The tests
    • The tools
• Linter & Code Quality
• Unit Tests
  • Deep dive on the test results
    • Skipped
    • Expected Fails
    • Errors
• Documenting your project with Sphinx and reStructuredText

Custom Tools

Unfortunately, sometimes the standard way is not always the most user-friendly, or the optimal process. So despite generally advising against it, I’ve collected a few tools of my own design to help work out some specific problems I could not solve otherwise.

• Python Project Cleaner
  • Introduction
  • How to clean the project tree
  • Developer’s documentation