What is Horreum Python Client?

Horreum python client is a high-level python library to interact with Horreum.

The raw client is generated using kiota OpenAPI generator tool starting from the Horreum OpenAPI spec.

Refer to the get started guide for comprehensive instructions on installing and utilizing this library.

What is Horreum?

Horreum is a service for storing performance data and regression analysis.

Contributing

Please check the CONTRIBUTING.md

If you have any idea or doubt 👇

• Ask a question
• Raise an issue
• Feature request
• Code submission

Contribution is the best way to support and get involved in community !

Please, consult our Code of Conduct policies for interacting in our community.

Consider giving the project a star on GitHub if you find it useful.

Development

Install poetry dependency (consider using Python virtual environments):

pip install --constraint=./dev-constraints.txt poetry
poetry --version

Generate source files

make generate

Build the library using poetry:

poetry build

Tests

Tests can be executed using nox sessions.

To install it in your local environment, please run:

pip install --constraint=./dev-constraints.txt nox nox-poetry
nox --version

To check available sessions, run:

nox -l

And execute them by running:

nox -s <session>

Right now integrations tests are not fully automated, therefore you need to start up the Horreum server manually, you can check more details in Horreum README.

NOTE: The database should be empty to get all tests working

Once the Horreum server is up and running on localhost:8080, you can trigger integration tests by running:

nox -s its

Release

Please check the RELEASE.md

License

Apache-2.0 license

Thanks to all the Contributors ❤️