Development¶
If you wish to contribute to this project, then you should fork the repository found here:
https://github.com/cjw296/xerotrust
Once that has been done and you have a checkout, you can follow the instructions below to perform various development tasks.
For detailed development guidelines, code style requirements, and additional commands,
see AGENTS.md in the repository root.
Setting up a development environment¶
uv sync --all-groups
Running from a development environment¶
The command line interface can be used from a development environment as follows:
uv run xerotrust --help
Running the tests¶
uv run -m pytest
Type check the code¶
uv run mypy src tests
Building the documentation¶
The Sphinx documentation is built by doing the following from the directory containing setup.py:
cd docs
make html
Making a release¶
To make a release:
update the version in
pyproject.tomlupdate the change log in
CHANGELOG.rstcommit on the
mainbranch and push to https://github.com/cjw296/xerotrust.
Carthorse should take care of the rest.
Xero API Documentation¶
The api-docs/ directory contains markdown files optimized for AI/LLM consumption
that were generated from the Xero Developer documentation.
See api-docs/README.md for details.