USPTOConfig

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', ptab_base_url='https://api.uspto.gov', enriched_citations_base_url='https://api.uspto.gov', oa_actions_base_url='https://api.uspto.gov', oa_rejections_base_url='https://api.uspto.gov', oa_citations_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.

__enter__()[source]

Enter context manager.

Return type:: USPTOConfig

__exit__(exc_type, exc_val, exc_tb)[source]

Exit context manager, closing the session.

Return type:: None

__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', ptab_base_url='https://api.uspto.gov', enriched_citations_base_url='https://api.uspto.gov', oa_actions_base_url='https://api.uspto.gov', oa_rejections_base_url='https://api.uspto.gov', oa_citations_base_url='https://api.uspto.gov', http_config=None, include_raw_data=False)[source]

Initialize the USPTOConfig.

Parameters:

api_key (str | None) – 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
ptab_base_url (str) – Base URL for the PTAB (Patent Trial and Appeal Board) API
enriched_citations_base_url (str) – Base URL for the Enriched Citations API
oa_actions_base_url (str) – Base URL for the Office Action Text Retrieval API
oa_rejections_base_url (str) – Base URL for the Office Action Rejections API
oa_citations_base_url (str) – Base URL for the Office Action Citations API
http_config (HTTPConfig | None) – 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)

close()[source]

Close the HTTP session and release resources.

This should be called when you’re done using this config and all clients created from it. After calling close(), the session will be recreated if accessed again.

Example

config = USPTOConfig(api_key=”…”) client = PatentDataClient(config=config) try:

# Use client pass

finally:: config.close()

Return type:: None

classmethod from_env()[source]

Create a USPTOConfig from environment variables.

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

property session: Session

Get the HTTP session for this config, creating it if needed.

The session is created lazily on first access and reused for all subsequent requests. All clients sharing this config will use the same session for connection pooling.

Returns:: The requests Session object with configured adapters.
Return type:: Session