Migrate USPTO client to ODP and remove PEDS

Author: parkerhancock

.env.example

@@ -0,0 +1,20 @@
+# Patent Client environment configuration example
+# Copy to .env and fill in values as needed.
+
+# Base configuration
+PATENT_CLIENT_LOG_LEVEL=INFO
+PATENT_CLIENT_LOG_FILE=patent_client.log
+
+# USPTO Open Data Portal API (required for ODP-backed features)
+PATENT_CLIENT_ODP_API_KEY=your-odp-api-key
+
+# European Patent Office OPS credentials (required for EPO integrations)
+PATENT_CLIENT_EPO_API_KEY=your-epo-consumer-key
+PATENT_CLIENT_EPO_API_SECRET=your-epo-consumer-secret
+
+# USITC EDIS credentials (optional, only needed for ITC workflows)
+PATENT_CLIENT_ITC_USERNAME=your-itc-username
+PATENT_CLIENT_ITC_PASSWORD=your-itc-password
+
+# Custom base directory for patent_client cache/logs (optional)
+# PATENT_CLIENT_BASE_DIR=/path/to/cache

.github/workflows/build.yaml

@@ -2,10 +2,10 @@ name: Build
 
 on:
   push:
-    branches: [main]
+    branches: [main, master]
     tags: ['v*']
   pull_request:
-    branches: [main]
+    branches: [main, master]
   workflow_dispatch:
 env:
   LATEST_PY_VERSION: '3.10'

README.md

@@ -30,14 +30,14 @@ In version 5, like in version 3, you can just `from patent_client import [Model]
 of the model. No asynchronous methods or functionality at all. Or you can do `from patent_client._async import [Model]`
 and get an asynchronous version of the model.
 
-Version 5 also brings support for the USPTO's new [Open Data Portal](https://beta-data.uspto.gov/home), a system currently in beta that is scheduled to replace the current Patent Examination Data System in late 2024.
+Version 5 also brings support for the USPTO's new [Open Data Portal](https://beta-data.uspto.gov/home). As of March 2025 the USPTO has retired the legacy Patent Examination Data System (PEDS), so `USApplication` now relies on the Open Data Portal APIs by default.
 
 ## Coverage
 
 - [United States Patent & Trademark Office][USPTO]
 
-  - [Patent Examination Data][PEDS] - Full Support
-  - [Open Data Portal][ODP] - Full Support
+  - [Open Data Portal][ODP] - Full Support (default `USApplication` backend)
+  - [Patent Examination Data][PEDS] - Retired by USPTO (legacy docs only)
   - [Global Dossier][GD] - Full Support
   - [Patent Assignment Data][Assignment] - Lookup Support
   - [Patent Trial & Appeal Board API v2][PTAB] - Supports Proceedings, Decisions, and Documents
@@ -108,6 +108,8 @@ True
 
 ```
 
+> **Note:** The USPTO Open Data Portal requires an API key. Set it via `PATENT_CLIENT_ODP_API_KEY` (see the [getting started guide](https://patent-client.readthedocs.io/en/latest/getting_started.html)) before calling `USApplication`.
+
 ## Async Quick Start
 
 To use async with Patent Client, just import the classes you need from the async module. All methods
@@ -149,4 +151,3 @@ Pull requests welcome!
 - [Google Public Patent Data](https://github.com/google/patents-public-data)
 - [PatentsView API Wrapper](https://github.com/mikeym88/PatentsView-API-Wrapper)
 - [USPTO Scrapy Scraper](https://github.com/blazers08/USPTO)
-

cassettes/patent_client/uspto/odp/api_test.py/test_get_application_basic_data.yaml

@@ -0,0 +1,47 @@
+interactions:
+- request:
+    body: ''
+    headers:
+      X-API-KEY:
+      - REDACTED
+      accept:
+      - '*/*'
+      accept-encoding:
+      - gzip, deflate, zstd
+      connection:
+      - keep-alive
+      host:
+      - api.uspto.gov
+      user-agent:
+      - Mozilla/5.0 Python Patent Clientbot/5.0.19 (parkerhancock@users.noreply.github.com)
+    method: GET
+    uri: https://api.uspto.gov/api/v1/patent/applications/16123456/assignment
+  response:
+    content: '{"count":1,"patentFileWrapperDataBag":[{"assignmentBag":[{"assignmentReceivedDate":"2018-09-07","assignorBag":[{"executionDate":"2018-07-11","assignorName":"KANADA,
+      SHOJI"}],"reelAndFrameNumber":"046816/0108","frameNumber":108,"assignmentRecordedDate":"2018-09-07","conveyanceText":"ASSIGNMENT
+      OF ASSIGNORS INTEREST (SEE DOCUMENT FOR DETAILS).","pageTotalQuantity":3,"assigneeBag":[{"assigneeAddress":{"cityName":"TOKYO","geographicRegionCode":"JPX","postalCode":"106-8620","addressLineOneText":"26-30,
+      NISHIAZABU 2-CHOME, MINATO-KU"},"assigneeNameText":"FUJIFILM CORPORATION"}],"assignmentMailedDate":"2018-09-10","reelNumber":46816,"correspondenceAddressBag":[{"addressLineOneText":"8110
+      GATEHOUSE ROAD, SUITE 100E","correspondentNameText":"BIRCH, STEWART, KOLASCH
+      & BIRCH, LLP","addressLineTwoText":"FALLS CHURCH, VA 22042"}],"assignmentDocumentLocationURI":"https://legacy-assignments.uspto.gov/assignments/assignment-pat-046816-0108.pdf"}],"applicationNumberText":"16123456"}],"requestIdentifier":"8e824662-53f0-4084-9eb9-213178161944"}'
+    headers:
+      access-control-allow-headers:
+      - Origin, X-Requested-With, Content-Type, Accept
+      access-control-allow-methods:
+      - OPTIONS,POST,GET
+      access-control-allow-origin:
+      - '*'
+      content-length:
+      - '1041'
+      content-type:
+      - application/json
+      date:
+      - Fri, 26 Sep 2025 19:17:27 GMT
+      x-amz-apigw-id:
+      - Rhj_EGuxIAMF-pw=
+      x-amzn-requestid:
+      - 8e824662-53f0-4084-9eb9-213178161944
+      x-amzn-trace-id:
+      - Root=1-68d6e6c6-3b47274469806e4222eec571;Parent=0a57dac5d5e77925;Sampled=0;Lineage=1:33e8fdb8:0
+    http_version: HTTP/2
+    status_code: 200
+version: 1