<div align="center">
# horreum-client-python
<a href="https://horreum.hyperfoil.io/"><img alt="Website" src="https://img.shields.io/website?up_message=live&url=https%3A%2F%2Fhorreum.hyperfoil.io/"></a>
<a href="https://github.com/Hyperfoil/horreum-client-python/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/Hyperfoil/horreum-client-python"></a>
<a href="https://github.com/Hyperfoil/horreum-client-python/fork"><img alt="GitHub forks" src="https://img.shields.io/github/forks/Hyperfoil/horreum-client-python"></a>
<a href="https://github.com/Hyperfoil/horreum-client-python/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/Hyperfoil/horreum-client-python"></a>
<a href="https://github.com/Hyperfoil/horreum-client-python/blob/main/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/Hyperfoil/horreum-client-python"></a>
</div>
---
## What is Horreum Python Client?
Horreum python client is a high-level python library to interact with [Horreum](#what-is-horreum).
The raw client is generated using [kiota](https://github.com/microsoft/kiota) OpenAPI generator tool starting from
the [Horreum OpenAPI spec](https://github.com/Hyperfoil/Horreum/blob/master/docs/site/content/en/openapi/openapi.yaml).
Refer to the [get started guide](docs/GET_STARTED.md) for comprehensive instructions on installing and utilizing this library.
## What is Horreum?
[Horreum](https://github.com/Hyperfoil/Horreum) is a service for storing performance data and regression analysis.
## Contributing
Please check the [CONTRIBUTING.md](./CONTRIBUTING.md)
### If you have any idea or doubt 👇
* [Ask a question](https://github.com/Hyperfoil/horreum-client-python/discussions)
* [Raise an issue](https://github.com/Hyperfoil/horreum-client-python/issues)
* [Feature request](https://github.com/Hyperfoil/horreum-client-python/issues)
* [Code submission](https://github.com/Hyperfoil/horreum-client-python/pulls)
Contribution is the best way to support and get involved in community !
Please, consult our [Code of Conduct](./CODE_OF_CONDUCT.md) policies for interacting in our
community.
Consider giving the project a [star](https://github.com/Hyperfoil/horreum-client-python/stargazers) on
[GitHub](https://github.com/Hyperfoil/horreum-client-python/) if you find it useful.
## Development
Install poetry dependency (consider using Python virtual environments):
```bash
pip install --constraint=./dev-constraints.txt poetry
poetry --version
```
Generate source files
```bash
make generate
```
Build the library using `poetry`:
```bash
poetry build
```
### Tests
Tests can be executed using [nox](https://nox.thea.codes/en/stable/) sessions.
To install it in your local environment, please run:
```bash
pip install --constraint=./dev-constraints.txt nox nox-poetry
nox --version
```
To check available sessions, run:
```bash
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](https://github.com/Hyperfoil/Horreum/blob/master/README.md#getting-started-with-development-server).
> **_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:
```bash
nox -s its
```
## Release
Please check the [RELEASE.md](./docs/RELEASE.md)
## License
[Apache-2.0 license](https://opensource.org/licenses/Apache-2.0)
## Thanks to all the Contributors ❤️
<img src="https://contrib.rocks/image?repo=Hyperfoil/horreum-client-python" />
Raw data
{
"_id": null,
"home_page": "https://github.com/Hyperfoil/horreum-client-python",
"name": "horreum",
"maintainer": "Andrea Lamparelli",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "alampare@redhat.com",
"keywords": "horreum, performance, change-detection",
"author": "Andrea Lamparelli",
"author_email": "alampare@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/95/10/c86c93e958a7d03cbee8481c4e5d67cf6a0596f7386522162fd849403039/horreum-0.19.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# horreum-client-python\n\n<a href=\"https://horreum.hyperfoil.io/\"><img alt=\"Website\" src=\"https://img.shields.io/website?up_message=live&url=https%3A%2F%2Fhorreum.hyperfoil.io/\"></a>\n<a href=\"https://github.com/Hyperfoil/horreum-client-python/issues\"><img alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/Hyperfoil/horreum-client-python\"></a>\n<a href=\"https://github.com/Hyperfoil/horreum-client-python/fork\"><img alt=\"GitHub forks\" src=\"https://img.shields.io/github/forks/Hyperfoil/horreum-client-python\"></a>\n<a href=\"https://github.com/Hyperfoil/horreum-client-python/stargazers\"><img alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/Hyperfoil/horreum-client-python\"></a>\n<a href=\"https://github.com/Hyperfoil/horreum-client-python/blob/main/LICENSE\"><img alt=\"GitHub license\" src=\"https://img.shields.io/github/license/Hyperfoil/horreum-client-python\"></a> \n\n</div>\n\n---\n## What is Horreum Python Client?\n\nHorreum python client is a high-level python library to interact with [Horreum](#what-is-horreum).\n\nThe raw client is generated using [kiota](https://github.com/microsoft/kiota) OpenAPI generator tool starting from\nthe [Horreum OpenAPI spec](https://github.com/Hyperfoil/Horreum/blob/master/docs/site/content/en/openapi/openapi.yaml).\n\nRefer to the [get started guide](docs/GET_STARTED.md) for comprehensive instructions on installing and utilizing this library.\n\n## What is Horreum?\n\n[Horreum](https://github.com/Hyperfoil/Horreum) is a service for storing performance data and regression analysis.\n\n## Contributing\n\nPlease check the [CONTRIBUTING.md](./CONTRIBUTING.md)\n\n### If you have any idea or doubt \ud83d\udc47\n\n* [Ask a question](https://github.com/Hyperfoil/horreum-client-python/discussions)\n* [Raise an issue](https://github.com/Hyperfoil/horreum-client-python/issues)\n* [Feature request](https://github.com/Hyperfoil/horreum-client-python/issues)\n* [Code submission](https://github.com/Hyperfoil/horreum-client-python/pulls)\n\nContribution is the best way to support and get involved in community !\n\nPlease, consult our [Code of Conduct](./CODE_OF_CONDUCT.md) policies for interacting in our\ncommunity.\n\nConsider giving the project a [star](https://github.com/Hyperfoil/horreum-client-python/stargazers) on\n[GitHub](https://github.com/Hyperfoil/horreum-client-python/) if you find it useful.\n\n## Development\n\nInstall poetry dependency (consider using Python virtual environments):\n```bash\npip install --constraint=./dev-constraints.txt poetry\npoetry --version\n```\n\nGenerate source files\n```bash\nmake generate\n```\n\nBuild the library using `poetry`:\n```bash\npoetry build\n```\n\n### Tests\nTests can be executed using [nox](https://nox.thea.codes/en/stable/) sessions.\n\nTo install it in your local environment, please run:\n```bash\npip install --constraint=./dev-constraints.txt nox nox-poetry\nnox --version\n```\n\nTo check available sessions, run:\n```bash\nnox -l\n```\n\nAnd execute them by running:\n```\nnox -s <session>\n```\n\nRight now integrations tests are not fully automated, therefore you need to start up the Horreum server manually,\nyou can check more details in [Horreum README](https://github.com/Hyperfoil/Horreum/blob/master/README.md#getting-started-with-development-server).\n\n> **_NOTE_**: The database should be empty to get all tests working\n\nOnce the Horreum server is up and running on `localhost:8080`, you can trigger integration tests by running:\n```bash\nnox -s its\n```\n\n## Release\nPlease check the [RELEASE.md](./docs/RELEASE.md)\n\n## License\n\n[Apache-2.0 license](https://opensource.org/licenses/Apache-2.0)\n\n## Thanks to all the Contributors \u2764\ufe0f\n\n<img src=\"https://contrib.rocks/image?repo=Hyperfoil/horreum-client-python\" />\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Horreum python library",
"version": "0.19",
"project_urls": {
"Homepage": "https://github.com/Hyperfoil/horreum-client-python",
"Issues": "https://github.com/Hyperfoil/horreum-client-python/issues"
},
"split_keywords": [
"horreum",
" performance",
" change-detection"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aaeac109e7d49e7d523cbf1d8741509dbac4fe01273b3663bfd2481267a41afb",
"md5": "b05e9bc688a961399a6da1c7460ecefa",
"sha256": "82d94dfe3abd90671f053042262d0cff9b3cb71d160d14cdfffbfd1db10edd80"
},
"downloads": -1,
"filename": "horreum-0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b05e9bc688a961399a6da1c7460ecefa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 246715,
"upload_time": "2025-10-10T13:47:14",
"upload_time_iso_8601": "2025-10-10T13:47:14.541755Z",
"url": "https://files.pythonhosted.org/packages/aa/ea/c109e7d49e7d523cbf1d8741509dbac4fe01273b3663bfd2481267a41afb/horreum-0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9510c86c93e958a7d03cbee8481c4e5d67cf6a0596f7386522162fd849403039",
"md5": "e9699caff2bba946108a6268ddf5e1b3",
"sha256": "62e1f52ee7a37aa7227f1005d96e1bc3eec34f111bd4e4f95ac378bc2122aa75"
},
"downloads": -1,
"filename": "horreum-0.19.tar.gz",
"has_sig": false,
"md5_digest": "e9699caff2bba946108a6268ddf5e1b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 62221,
"upload_time": "2025-10-10T13:47:15",
"upload_time_iso_8601": "2025-10-10T13:47:15.760289Z",
"url": "https://files.pythonhosted.org/packages/95/10/c86c93e958a7d03cbee8481c4e5d67cf6a0596f7386522162fd849403039/horreum-0.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-10 13:47:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Hyperfoil",
"github_project": "horreum-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "horreum"
}
JSON
