We welcome pull requests for general contributions. If you have a large new feature or any questions on how to develop a fix, we recommend you open an issue before starting.
exchange uses uv for dependency management, and formats with ruff.
We provide a shortcut to standard commands using just in our justfile.
Now that you have a local environment, you can make edits and run our tests.
uv run pytest tests -m "not integration"
or, as a shortcut,
just testGenerally if you are not developing a new provider, you can test most functionality through mocking and the normal test suite.
However, to ensure the providers work, we also have integration tests which actually require a credential and connect to the provider endpoints. Those can be run with
uv run pytest tests -m integration
# or `just integration`To run integration tests against Ollama, you need the model that tests expect available locally.
First, run ollama and pull the models you want to test.
ollama serve
# Then in another terminal, pull the model
OLLAMA_MODEL=$(uv run python -c "from src.exchange.providers.ollama import OLLAMA_MODEL; print(OLLAMA_MODEL)")
ollama pull $OLLAMA_MODELFinally, run ollama integration tests.
uv run pytest tests -m integration -k ollama
# or `just integration -k ollama`When opening a pull request, please ensure that your PR title adheres to the Conventional Commits specification. This helps us maintain a consistent and meaningful changelog.