Skip to content

Installation

Prerequisites

  • Python 3.9 or higher
  • pip (Python package installer)

The easiest way to install the USPTO ODP Python Client is using pip:

pip install uspto_odp

Install from Source

If you want to install from the source code:

  1. Clone the repository: 

    git clone https://github.com/KennethThompson/uspto_odp.git
cd uspto_odp

  2. Install the package in development mode: 

    pip install -e .

Development Installation

If you plan to contribute or modify the code, install with development dependencies:

pip install -e ".[dev]"

This includes: - pytest - Testing framework - pytest-asyncio - Async test support - coverage - Code coverage tools - python-dotenv - Environment variable management

Documentation Dependencies

To build the documentation locally:

pip install -e ".[docs]"

This includes: - mkdocs - Documentation generator - mkdocs-material - Material theme - mkdocstrings[python] - Python docstring parser

Verify Installation

You can verify the installation by running:

import uspto_odp
print(uspto_odp.__version__)

API Key Required

Before using the library, you'll need to obtain an API key from the USPTO Developer Hub:

  1. Visit USPTO Developer Hub
  2. Sign up for an account
  3. Request an API key
  4. Keep your API key secure and never commit it to version control

Next Steps