OSIDB Bindings
A Pythonic way to talk to OSIDB without getting lost in HTTP details.
Requirements
- gcc
- krb5-devel
- pip
- python3
- python3-devel
Installation
Install the bindings using pip (recommended within a virtual environment):
pip install osidb-bindings
Quick Start
Basic Authentication
import osidb_bindings
# For local OSIDB instances with username/password authentication
session = osidb_bindings.new_session(
osidb_server_uri="http://localhost:8000/",
username="your_username",
password="your_password"
)
Kerberos Authentication
# For production/staging instances with Kerberos authentication (default)
session = osidb_bindings.new_session(osidb_server_uri="https://your-osidb-instance.com/")
Basic Operations
# Check connection status
status = session.status()
# Retrieve a specific flaw
flaw = session.flaws.retrieve(id="CVE-1111-2222")
# Access flaw attributes
print(flaw.title)
print(flaw.impact)
# Convert to dictionary for easier manipulation
flaw_dict = flaw.to_dict()
print(flaw_dict["title"])
print(flaw_dict["impact"])
# Retrieve multiple flaws with filtering
critical_flaws = session.flaws.retrieve_list(impact="CRITICAL")
recent_flaws = session.flaws.retrieve_list(changed_after="2023-01-01")
# Access paginated results
print(f"Total flaws found: {critical_flaws.count}")
for flaw in critical_flaws.results:
print(f"CVE: {flaw.cve_id}, Impact: {flaw.impact}")
API Version Control
# Use latest API version (default behavior)
flaw = session.flaws.retrieve(id="CVE-1111-2222")
# Specify a particular API version for stability
flaw = session.flaws.retrieve(id="CVE-1111-2222", api_version="v1")
# Discover available API versions
print(session.endpoints)
Documentation
- Complete Tutorial - Comprehensive guide with examples
- Developer Guide - Development and contribution guidelines
Features
- Automatic Authentication - Handles JWT token refresh automatically
- Multiple API Versions - Support for v1, v2, and future API versions
- Intuitive Interface - Pythonic API that mirrors OSIDB REST endpoints
- Comprehensive Coverage - Access to flaws, affects, trackers, and more
- Pagination Support - Built-in handling of paginated responses
- Error Handling - Clear exceptions for better debugging
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
osidb_bindings-5.13.0.tar.gz
(333.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file osidb_bindings-5.13.0.tar.gz.
File metadata
- Download URL: osidb_bindings-5.13.0.tar.gz
- Upload date:
- Size: 333.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1df96df59f71a53d2f7f2bb09d38103f84b8ae3ad3c1ab4988cf3d94afb7cc2e
|
|
| MD5 |
b36c16ceb900e2da55aecd8051c9ebbe
|
|
| BLAKE2b-256 |
eab2c783b487c9d33d242993727f3ee11cf5c8c964dede4465f3fb704b7f34fa
|
File details
Details for the file osidb_bindings-5.13.0-py3-none-any.whl.
File metadata
- Download URL: osidb_bindings-5.13.0-py3-none-any.whl
- Upload date:
- Size: 827.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
847fd986c27a1dbbf3ab8496accb49fead256db068cdc8814faac2c0d537307b
|
|
| MD5 |
7b17bef8c6f1cce487f89632dd1d167f
|
|
| BLAKE2b-256 |
49bf9d65b4db1be75aed58c337c14cb0bab759d485067382162c8c6c0c9c164e
|
