Development

• Install dev dependencies with Poetry.

poetry install --all-extras --with dev,docs
poetry shell
pre-commit install

• Run tests.

docker network create tomodachi-testcontainers

make test  # Run tests during development
make test-docs-src  # Test documentation code examples
make test-ci  # Run all tests with code coverage

• Format and lint code.

make format
make lint

• Run all commit hooks at once.

make hooks

• Build package release.

poetry build

• Develop documentation with Material for MkDocs.

mkdocs serve

• Generate C4 diagrams with PlantUML (get plantuml.jar at https://plantuml.com/starting).

export JAVA_HOME=`/usr/libexec/java_home -v 21`

java -jar plantuml.jar -DRELATIVE_INCLUDE="." docs/**/*.puml

• Run PlantUML server.

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty