Configuration

config - Configuration management for USPTO API clients

This module provides configuration management for USPTO API clients.

class pyUSPTO.config.USPTOConfig(api_key=None, bulk_data_base_url='https://api.uspto.gov/api/v1/datasets', patent_data_base_url='https://api.uspto.gov/api/v1/patent')[source]

Bases: object

Configuration for USPTO API clients.

__init__(api_key=None, bulk_data_base_url='https://api.uspto.gov/api/v1/datasets', patent_data_base_url='https://api.uspto.gov/api/v1/patent')[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

classmethod from_env()[source]

Create a USPTOConfig from environment variables.

Return type:: USPTOConfig
Returns:: USPTOConfig instance