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