🛠️ Codebase Overview#

The project is hosted on whiteprints/whiteprints.git.

It is organised as follow.

Files and directories#

Here is a list of important resources for contributors:

  • The licences: located in the LICENCES/ directory.

  • The project source code: located in the src/ directory.

  • The tests: located in the tests/ directory.

  • The documentation source code: located in the docs/ directory.

  • justfile contains Just’s configuration

  • pyproject.toml contains the project metadata and the build system

Tools#

The project relies on the following tools for development:

  • pip-audit: used to find vulnerabilities in the supply chain.

  • pre-commit: used to identifying simple issues before submission.

  • pyright: used for type checking and as LSP.

  • reuse: check the licenses compliance.

  • ruff: check and fix the Python’s code format and syntax.

  • cyclonedx-bom: generate a bill of material of the supply chain.

  • Just: orchestrate tools and tests.

You may install all the tools using [uv]:

uv tool install pip-audit
uv tool install pre-commit --with "pre-commit-uv"
uv tool install pyright
uv tool install reuse
uv tool install ruff
uv tool install cyclonedx-bom
uv tool install rust-just"
On this page

This Page