MPSREPO

MPSDESC

Commands

Docker (Compose)

Building the docker container in a detached state:

docker compose up --build -d

Building the development docker container in a detached state:

docker compose -f docker-compose-dev.yml up --build -d

Stopping the docker container:

docker compose down

Running a command in the container:

docker compose run MPSSRC_app <command>

Poetry

Starting a new package:

poetry new --src MPSSRC

Installing dependencies:

poetry install  # --with/without <group>

Updating dependencies:

poetry update  # <package1_name> <package2_name>

Add a dependency:

poetry add <package>  # --group dev

Remove a dependency:

poetry remove MPSSRC  # --group dev

List available packages:

poetry show

Run a command with poetry:

poetry run <command>

Validate the structure of pyproject.toml:

poetry check

Export the dependencies to a requirements.txt file:

poetry export --without dev -f requirements.txt --output requirements.txt

Export the dev-dependencies to a requirements-dev.txt file:

poetry export --with dev -f requirements.txt -o dev-requirements.txt

Pre-commit

Install pre-commit hooks:

pre-commit install

Run all pre-commit hooks:

pre-commit run -a

Sphinx

Build the modules:

poetry run sphinx-apidoc -f -o docs MPSSRC

Build the documentation files:

poetry run make -C docs html
# documentation can now be found at docs/_build/html/index.html

Clean the documentation files:

poetry run make -C docs clean