Contributor Installation

You want to contribute to this project? :tada:
You are more than welcome! Please read the instructions below before getting started.

Supported OS

A Python virtual environment is strongly recommended to avoid dependency conflicts. This project uses Poetry for development.

This project follows Black code rules. Please respect this convention.

If you are using VS Code with Poetry, some Black exclusions are defined in pyproject.toml. To add more, see the pydocstyle error codes.

The documentation stack is:

mkdocstrings — Auto-generates API docs from Python docstrings (Google-style)
mkdocs-material — Material theme for mkdocs
awesome-pages — Navigation ordering via .pages files

See Tests & Documentation for the full workflow.

Once your prerequisites are met:

cd /path/to/sysplant
poetry shell
poetry install

To also install MCP server dependencies for development:

poetry install --with mcp

Tip

If you encounter a DBusError during install, set: bash export PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring

poetry config repositories.test-pypi https://test.pypi.org/legacy/

poetry config pypi-token.test-pypi pypi-YYYYYYYY

poetry publish -r test-pypi