Skip to main content

USPTO 특허 심사과정 분석 CLI — 문서 다운로드 · XML 파싱 · MD 생성

Project description

uspto-oa-cli

A CLI tool that downloads USPTO patent prosecution documents via the ODP (Open Data Portal) API, parses the XML, and converts them into structured Markdown.

Supports a workflow where the generated MD file is passed to AI agents (Claude Code, Gemini CLI, etc.) for prosecution strategy analysis.

Requirements

Installation

# pip
pip install uspto-oa-cli

# uv (global install)
uv tool install uspto-oa-cli

# uv (add as project dependency)
uv add uspto-oa-cli

# local development
uv sync

API Key Setup

# Interactive setup (recommended) — saved to ~/.oa-cli.toml
uspto-oa configure

# Show current configuration
uspto-oa configure --show

Or set via environment variable:

export USPTO_API_KEY=your_api_key_here

Usage

# 0. Check document list before downloading
uspto-oa list 16330077

# 1. Download documents (saved to file/{app_num}/)
uspto-oa download 16330077

# 2. Parse XML → generate prosecution.md
uspto-oa extract 16330077
# Output: file/16330077/16330077_prosecution.md

# Extract in JSON format
uspto-oa extract 16330077 --format json

# Download specific document codes only
uspto-oa download 16330077 --doc-codes CTNF,CTFR,NOA

# Force re-download (overwrite existing files)
uspto-oa download 16330077 --force

# Verbose logging
uspto-oa -v download 16330077

# One-time API key override
uspto-oa download 16330077 --api-key YOUR_KEY

Command Options

uspto-oa list <application>

Option Description
--all Show all documents without prosecution-related filter
--format [table|json] Output format (default: table)
--api-key TEXT API key

uspto-oa download <application>

Option Description
--doc-codes CODES Comma-separated document codes (e.g. CTNF,CTFR,NOA). All prosecution docs if omitted
--output-dir DIR Save path (default: file/{app_num}/)
--force Re-download even if file already exists
--api-key TEXT API key (overrides config file and environment variable)

uspto-oa extract <application>

Option Description
--format [md|json] Output format (default: md)
--output-dir DIR File directory (default: file/{app_num}/)

Workflow

uspto-oa list {app_num}           # Check document list before downloading
    └─ Browse prosecution document codes and formats

uspto-oa download {app_num}
    └─ Save XML / PDF to file/{app_num}/

uspto-oa extract {app_num}
    └─ Generate file/{app_num}/{app_num}_prosecution.md
         └─ AI agent (Claude Code / Gemini CLI)
              └─ Prosecution strategy analysis, summaries, Q&A

Collected Document Codes

Code Description
CTNF Non-Final Office Action
CTFR Final Office Action
NOA / NACT Notice of Allowance
REM Remarks
ABN Abandonment
SRNT / SRFW Search Report
EXIN Examiner Interview
RCE / RCEX Request for Continued Examination
CTAV Advisory Action
892 / 1449 / IDS Prior Art / IDS
A* All Amendment variants

Generated File Structure

file/{app_num}/{app_num}_prosecution.md:

Section Content
Timeline All documents sorted by date (XML/PDF format shown)
Office Action Details Full rejection grounds from CTNF/CTFR
Amendment Details Amended claims (CLM) + Remarks (REM)
Examiner Interview Details Full EXIN text
Notice of Allowance Details Allowed claims + Examiner's Statement
PDF-only Documents Image PDF list (for direct AI agent delivery)

PyPI Release

uv build
uv run twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uspto_oa_cli-0.1.4.tar.gz (41.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uspto_oa_cli-0.1.4-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file uspto_oa_cli-0.1.4.tar.gz.

File metadata

  • Download URL: uspto_oa_cli-0.1.4.tar.gz
  • Upload date:
  • Size: 41.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for uspto_oa_cli-0.1.4.tar.gz
Algorithm Hash digest
SHA256 6e0097f85b783b5487b4d1e6c2b1cb43ab0444691803a39403737cc2a77e8726
MD5 7c96c90ad5bf23a1a869629ab97853a0
BLAKE2b-256 31105f97dabb0b19546539cc37430cbb64baf5d45ea37f3cc7c90267d58a7b57

See more details on using hashes here.

File details

Details for the file uspto_oa_cli-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: uspto_oa_cli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for uspto_oa_cli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ca2e224f1eb89847cc0aeb6162dbdfe3311483116a8c03b4a83758d5c15e5c43
MD5 0ac2df0a059e6f9fb1817d9ae14be09b
BLAKE2b-256 6c0d49c9e759a4f6dad5d0429089080508a50ed94b500f8d47a503faa8c907a6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page