Developer Documentation for irorun¶
irorun is a unified command-line tool designed to bootstrap Python projects with integrated code quality checks, formatting, and documentation generation. Originally conceived to help research teams—especially in physics—focus on their core work without getting bogged down by complex setup and maintenance tasks, irorun streamlines the creation of a standardized project environment.
In these documents you will find:
An overview of the project’s architecture and design decisions.
Detailed instructions for setting up a development environment.
Configuration guides for both project bootstrapping and logging.
A reference for CLI commands and their options.
Testing procedures and coverage reporting guidelines.
Contribution guidelines and a roadmap for future enhancements.
This guide is intended for developers and contributors looking to understand, maintain, or extend irorun.