Skip to content

Development Setup

Run commands from the repository root. Python runtime dependencies are listed in requirements.txt; documentation dependencies are in requirements-docs.txt.

Environment

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Create a local .env using the variable list and descriptions in the repository README. Keep credentials and generated OAuth token caches untracked.

Run the Middleware

python -m flask --app server --debug run --host=127.0.0.1 -p 5050

The application uses feature-scoped settings validation. A route needs the credentials and configuration for the services it actually uses. See Flask architecture and Xero authentication.

Verify Changes

pytest -q

Mock external service responses for offline tests. Review one-off scripts with their --help and dry-run mode before applying changes to Zoho.

For documentation commands, see documentation sites.