Installation and Development Setup¶
This section explains how to set up a development environment for irorun.
Requirements¶
Python 3.11 or later
pip (or your preferred package manager)
Virtual environment tools (e.g., virtualenv, Poetry, or uv)
Steps to Set Up Your Environment¶
Clone the Repository:
git clone https://github.com/yourusername/irorun.git cd irorun
Create a Virtual Environment:
Choose your preferred method. For example, using virtualenv:
python -m virtualenv venv source venv/bin/activate # On Windows: venv\Scripts\activate
Or with Poetry:
poetry install
Install in Editable Mode:
To facilitate development, install irorun in editable mode:
pip install -e .
Install Development Dependencies:
If you maintain a separate file (e.g., requirements-dev.txt) for development tools:
pip install -r requirements-dev.txt
Verify Installation:
Run the following to ensure the CLI is working:
irorun --help
This should display the list of available commands and options.