Design

We wanted to make a piece of software that was easy to use, robust to different types of inputs, and easy to document.

We developed this software using a command-line interface (CLI) package in python called typer, which provides both improvements for developers and ease-of-use for users, as well.

We check inputs using the pydantic package, which allows us to provide expected inputs and clear error messages when an input fails.

And we developed this site using mkdocs and the mkdocs-material theme, which enables faster and somewhat automated documentation generation.

In terms of transparency, the code is available in our self-hosted gitlab