Configuration

config - Configuration management for USPTO API clients

This module provides configuration management for USPTO API clients, including API keys, base URLs, and HTTP transport settings.

class pyUSPTO.config.USPTOConfig(api_key=None, bulk_data_base_url='https://api.uspto.gov', patent_data_base_url='https://api.uspto.gov', petition_decisions_base_url='https://api.uspto.gov', http_config=None, include_raw_data=False)[source]

Bases: object

Configuration for USPTO API clients.

Manages API-level configuration (keys, URLs) and optionally accepts HTTP transport configuration via HTTPConfig.

__init__(api_key=None, bulk_data_base_url='https://api.uspto.gov', patent_data_base_url='https://api.uspto.gov', petition_decisions_base_url='https://api.uspto.gov', http_config=None, include_raw_data=False)[source]

Initialize the USPTOConfig.

Parameters:

api_key (Optional[str]) – API key for authentication, defaults to USPTO_API_KEY environment variable
bulk_data_base_url (str) – Base URL for the Bulk Data API
patent_data_base_url (str) – Base URL for the Patent Data API
petition_decisions_base_url (str) – Base URL for the Final Petition Decisions API
http_config (Optional[HTTPConfig]) – Optional HTTPConfig for request handling (uses defaults if None)
include_raw_data (bool) – If True, store raw JSON in response objects for debugging (default: False)

classmethod from_env()[source]

Create a USPTOConfig from environment variables.

Return type:: USPTOConfig
Returns:: USPTOConfig instance with values from environment