Development Setup¶

Prerequisites¶

• Python 3.13+ (required)
• Poetry for dependency management
• Git for version control

Setup Instructions¶

1. Clone the repository

git clone https://github.com/jonaskahn/cadence.git
cd cadence

1. Install dependencies

poetry install
poetry install --with docs  # For documentation development

1. Set up environment

cp .env.example .env
# Edit .env with your configuration

1. Run the application

poetry run python -m cadence start all

1. Run tests

poetry run pytest

1. Build documentation

   poetry run mkdocs serve  # Live reload at http://localhost:8000
   poetry run mkdocs build  # Build static site
   

Development Workflow¶

1. Create a feature branch

git checkout -b feature/your-feature-name

1. Make your changes

   • Follow the code style guidelines
   • Add tests for new functionality
   • Update documentation as needed

2. Run quality checks

poetry run black .
poetry run isort .
poetry run mypy .
poetry run pytest

1. Commit and push

git add .
git commit -m "feat: add your feature"
git push origin feature/your-feature-name

1. Create a pull request
   • Use the GitHub web interface
   • Provide a clear description of changes
   • Reference any related issues