# osidb-bindings
A client library for accessing OSIDB API
## Requirements
* gcc
* krb5-devel
* pip
* python3
* python3-devel
## Installation
```
pip install osidb-bindings
```
## Usage
```python
import osidb_bindings
# Basic auth
osidb_session = osidb_bindings.new_session(osidb_server_uri="http://localhost:8000/", username="username", password="password")
```
or
```python
# Default kerberos auth
osidb_session = osidb_bindings.new_session(osidb_server_uri="http://localhost:8000/")
```
```python
# Get status
osidb_session.status()
# Retrieve flaw
flaw = osidb_session.flaws.retrieve(id="CVE-1111-2222")
# Fields can be accessed directly via attributes
flaw.title
flaw.impact
# or the flaw can be converted into dict
flaw_dict = flaw.to_dict()
flaw_dict["title"]
flaw_dict["impact"]
# Retrieving multiple flaws
all_flaws = osidb_session.flaws.retrieve_list()
# All query params listed in OpenAPI schema can be passed as well
filtered_flaws = osidb_session.flaws.retrieve_list(impact="IMPORTANT", tracker_ids=["111111", "222222"])
# number of results
filtered_flaws.count
# list with the results
filtered_flaws.results
```
## For more details read [tutorial](TUTORIAL.md)
## For development details read [developer guide](DEVELOP.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/RedHatProductSecurity/osidb-bindings",
"name": "osidb-bindings",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Jakub Frejlach, Red Hat Product Security",
"author_email": "jfrejlac@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/b3/96/c13d820908912612c097d0a71129a735f6f2b97669191324582daf088b18/osidb_bindings-4.14.1.tar.gz",
"platform": null,
"description": "# osidb-bindings\nA client library for accessing OSIDB API\n\n## Requirements\n* gcc\n* krb5-devel\n* pip\n* python3\n* python3-devel\n\n## Installation\n\n```\npip install osidb-bindings\n```\n\n## Usage\n\n```python\nimport osidb_bindings\n\n# Basic auth\nosidb_session = osidb_bindings.new_session(osidb_server_uri=\"http://localhost:8000/\", username=\"username\", password=\"password\")\n```\nor\n```python\n# Default kerberos auth\nosidb_session = osidb_bindings.new_session(osidb_server_uri=\"http://localhost:8000/\")\n```\n\n```python\n# Get status\nosidb_session.status()\n\n# Retrieve flaw\nflaw = osidb_session.flaws.retrieve(id=\"CVE-1111-2222\")\n\n# Fields can be accessed directly via attributes\nflaw.title\nflaw.impact\n\n# or the flaw can be converted into dict\nflaw_dict = flaw.to_dict()\nflaw_dict[\"title\"]\nflaw_dict[\"impact\"]\n\n# Retrieving multiple flaws\nall_flaws = osidb_session.flaws.retrieve_list()\n\n# All query params listed in OpenAPI schema can be passed as well\nfiltered_flaws = osidb_session.flaws.retrieve_list(impact=\"IMPORTANT\", tracker_ids=[\"111111\", \"222222\"])\n\n# number of results\nfiltered_flaws.count\n\n# list with the results\nfiltered_flaws.results\n```\n\n## For more details read [tutorial](TUTORIAL.md)\n\n## For development details read [developer guide](DEVELOP.md)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python bindings for accessing OSIDB API",
"version": "4.14.1",
"project_urls": {
"Changelog": "https://github.com/RedHatProductSecurity/osidb-bindings/blob/master/CHANGELOG.md",
"Documentation": "https://github.com/RedHatProductSecurity/osidb-bindings/blob/master/TUTORIAL.md",
"Homepage": "https://github.com/RedHatProductSecurity/osidb-bindings",
"Source": "https://github.com/RedHatProductSecurity/osidb-bindings"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "143e1c022089c116bdde89d45a1ca2a9fe9e973b801325e82dc970e9c89f5e2c",
"md5": "72c69abaac1176db77d11c53163fe431",
"sha256": "fec0b6caf789245e5187954a412930fe1a0290922dc2650400ea9dabdde1fc76"
},
"downloads": -1,
"filename": "osidb_bindings-4.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72c69abaac1176db77d11c53163fe431",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 576756,
"upload_time": "2025-08-05T11:40:01",
"upload_time_iso_8601": "2025-08-05T11:40:01.486983Z",
"url": "https://files.pythonhosted.org/packages/14/3e/1c022089c116bdde89d45a1ca2a9fe9e973b801325e82dc970e9c89f5e2c/osidb_bindings-4.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b396c13d820908912612c097d0a71129a735f6f2b97669191324582daf088b18",
"md5": "89bc00dbfacb80f9d1fdc5f065a313ba",
"sha256": "f76e7abe6b7e9a33ed4113332cad49b08eefe8ae644f23c8a1fc475aa4afeb96"
},
"downloads": -1,
"filename": "osidb_bindings-4.14.1.tar.gz",
"has_sig": false,
"md5_digest": "89bc00dbfacb80f9d1fdc5f065a313ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 197788,
"upload_time": "2025-08-05T11:40:02",
"upload_time_iso_8601": "2025-08-05T11:40:02.965172Z",
"url": "https://files.pythonhosted.org/packages/b3/96/c13d820908912612c097d0a71129a735f6f2b97669191324582daf088b18/osidb_bindings-4.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-05 11:40:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RedHatProductSecurity",
"github_project": "osidb-bindings",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "osidb-bindings"
}
JSON
