pyUSPTO 0.5.7__tar.gz → 0.6.0__tar.gz

{pyuspto-0.5.7 → pyuspto-0.6.0}/.github/workflows/python-tests.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.11", "3.12", "3.13", "3.14", "3.15"]
 
     steps:
       - uses: actions/checkout@v7

{pyuspto-0.5.7 → pyuspto-0.6.0}/ADVANCED.md

@@ -80,7 +80,7 @@ patent_config = USPTOConfig(api_key="key1", http_config=http_config)
 petition_config = USPTOConfig(api_key="key2", http_config=http_config)
 
 patent_client = PatentDataClient(config=patent_config)
-petition_client = FinalPetitionDecisionsClient(config=petition_config)
+petition_client = PetitionDecisionsClient(config=petition_config)
 ```
 
 ## Environment Variables Reference

{pyuspto-0.5.7 → pyuspto-0.6.0}/CHANGELOG.md

@@ -5,6 +5,53 @@ All notable changes to the pyUSPTO package will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.0]
+
+### Added
+
+- Python 3.15 support.
+- `PetitionDecision` fields from USPTO ODP Release 5.0: `decided_petition_type_code`, `decided_petition_type_code_description_text`, `decision_mail_date`, `application_status_date`, `application_status_description_text`, `final_petition_decision_indicator`, `ocr_search_text`, `all_searchable_fields`, and `last_modified_date_time`. Also `decision_petition_type_code_description_text`, which the API returned but the model never read.
+- `PetitionDecisionsClient.search_decisions(decided_petition_type_code_q=...)` filters on `decidedPetitionTypeCode`.
+- `BaseUSPTOClient.paginate_results(count_is_total=False)` paginates APIs whose `count` is the size of the current page rather than the total.
+
+### Changed
+
+- **Breaking:** `FinalPetitionDecisionsClient` is renamed `PetitionDecisionsClient`. Since USPTO ODP Release 5.0 the Petition Decisions API returns final and non-final decisions, so the old name no longer fit. `FinalPetitionDecisionsClient` is now a subclass that restricts every search, pagination, and `download_decisions` call to final decisions (`finalPetitionDecisionIndicator` true) and returns `None` from `get_decision_by_id` for a non-final decision. Code that used `FinalPetitionDecisionsClient` for all decisions must switch to `PetitionDecisionsClient`.
+- `DecisionTypeCode` now covers all four decided types: `GRANTED` (`A`), `GRANTED_IN_PART` (`B`), `DENIED` (`C`), and `DISMISSED` (`D`).
+- **Breaking:** `PetitionDecision.decision_petition_type_code` is now a `str`, matching the API.
+- `DocumentMimeType` is now a `StrEnum`. `str()` and f-strings return the value (`"PDF"`) instead of `"DocumentMimeType.PDF"`. Equality with plain strings and `.value` are unchanged.
+- `PetitionDecisionsClient.search_decisions(sort=...)` accepts a list of sort keys, sent as repeated `sort` parameters (the API rejects comma-joined keys).
+- `ifw_example.py` looks up its publication number as plain digits; the library adds the search wildcards itself.
+- **Breaking:** `paginate_*` methods yield nothing for a search with no matches instead of raising `USPTOApiNotFoundError` (the search endpoints answer no-match with HTTP 404), matching `get_patent` and the other single lookups. Code that caught that exception around a pagination loop can drop the `try`.
+
+### Removed
+
+- **Breaking:** Dropped support for Python 3.10, which has reached end of life. The minimum supported version is now Python 3.11.
+- `typing-extensions` is no longer a dependency; `Self` is imported from `typing` directly.
+- **Breaking:** `PetitionDecision.decision_type_code`, `decision_type_code_description_text`, and `last_ingestion_datetime`, and `search_decisions(decision_type_code_q=...)`. USPTO ODP Release 5.0 replaced `decisionTypeCode` with `decidedPetitionTypeCode`, and the API sends `lastModifiedDateTime` instead of `lastIngestionDateTime`, so these were always `None` and the filter never matched. Use the new fields under Added.
+- **Breaking:** `PetitionDecisionDocument.direction_category` and the `DocumentDirectionCategory` enum. Petition decision documents have no `directionCategory` (none of the roughly 1.1 million decisions), so the attribute was always `None`.
+- **Breaking:** the `include_documents` parameter of `get_decision_by_id` on both petition clients. The API returns a decision's documents without it.
+- **Breaking:** `PetitionDecisionDocument.application_number_text`. The API never returns it: none of the roughly 1.1 million decisions has a document with `applicationNumberText`. `PetitionDecision.application_number_text` is unchanged.
+
+### Fixed
+
+- `Document.direction_category` (patent application documents) was always `None`. The model read `documentDirectionCategory`, but the API sends `directionCategory`. `to_dict()` now emits `directionCategory`, and `DirectionCategory` gains `INTERNAL`, which the API uses for about a fifth of documents.
+- `earliestPublicationNumber_q` (used by `search_applications`, `get_publication`, and `get_IFW_metadata(publication_number=...)`) is now reduced to its digits and searched with wildcards, so bare digits (`20210138233`), `US`-prefixed forms, kind codes, and separators (`US 2021/0138233 A1`) all match the stored `USyyyyNNNNNNNAn` value. Previously the value was sent verbatim and bare digits never matched. Values already containing `*` pass through unchanged.
+- **Breaking:** `get_patent`, `get_publication`, `get_pct` (publication form), and the search-based branches of `get_IFW_metadata` now return `None` on no match, as documented. The search endpoint answers no-match with HTTP 404, which previously surfaced as `USPTOApiNotFoundError`. Code that caught that exception from these methods should check for `None` instead.
+- Unit tests no longer depend on `USPTO_*` variables set in the developer's shell. An autouse fixture in `tests/conftest.py` clears every variable `USPTOConfig` reads (`USPTO_API_KEY`, the `USPTO_*_BASE_URL` variables, and the HTTP-setting variables such as `USPTO_REQUEST_TIMEOUT`) before each unit test.
+- `petition_decisions_example.py` no longer fails when rerun (its document download now passes `overwrite=True`), and its pagination example prints each decision under a page header.
+- Pagination on clients whose `count` is the total (every client except bulk data) requested one page past the end when the total number of results was an exact multiple of the page size. The petition API answers that request with a 404.
+- `BulkDataClient.paginate_products` returned at most two pages of products (for example 20 of 47 with `limit=10`). The bulk data API's `count` is the size of the current page, not the total, so pagination now stops on a short page, or on the 404 the API returns past the last product.
+- POST pagination in `paginate_applications`, `paginate_decisions` (petitions, PTAB appeals, PTAB interferences), and `paginate_proceedings` failed with a 400 unless `post_body` already had a `pagination` dict, because the API rejects top-level `offset`/`limit`. Offset and limit now always go in `post_body["pagination"]`, and a top-level `limit` raises `ValueError`.
+- `paginate_decisions` repeated and skipped decisions (about 1 in 5) because the API orders tied records differently on each request. It now appends `petitionDecisionRecordIdentifier asc` to the sort.
+- Docstring examples that failed against the API: a top-level `limit` in POST bodies (petitions, PTAB appeals, PTAB interferences), an unknown `download_decisions` argument, dead decision IDs, a string `fields` in the `paginate_applications` POST body, and PTAB queries on field names the API doesn't have.
+- Documented the `filters` syntax for petition and PTAB searches: `"field value"` with a space, not a colon (the API rejects the colon form), and PTAB field names are nested (e.g. `decisionData.decisionTypeCategory`). Unit tests now use valid filter strings.
+- `get_decision_by_id(..., include_documents=...)` returned an unrelated decision, with only a `USPTODataMismatchWarning`: any query parameter on that endpoint, including the documented `includeDocuments`, makes the API ignore the ID.
+- The contributor docs implied the development environment runs on Python 3.11, but its documentation tools (Sphinx 9.1) need 3.12+. `CONTRIBUTING.md` and the installation page now state 3.12+ as the development minimum.
+- An API error whose JSON body isn't an object (a list, string, or number) raised `AttributeError` while the exception was being built. It now falls back to the HTTP reason and the response text, like any other body without error fields.
+- Archive downloads now extract only regular files from a TAR. Named pipes and device files are skipped, and the archive's permission bits and ownership are no longer applied, so a setuid flag is dropped and files get default permissions. Previously Python 3.11–3.13 recreated these entries as stored, and Python 3.14 stopped partway with `tarfile.SpecialFileError`.
+- A ZIP download holding one file whose stored name contains `..` (e.g. `a/../b.txt`) returned a path that didn't exist. It now returns the path the file was written to.
+
 ## [0.5.5] - 2026-07-22
 
 ### Added

{pyuspto-0.5.7 → pyuspto-0.6.0}/CONTRIBUTING.md

@@ -22,8 +22,6 @@ cd pyUSPTO
 
 ### Set Up Development Environment
 
-> **Note:** Python 3.11+ is required for the development environment. Some dev dependencies (e.g. `myst-parser`) do not support Python 3.10. The package itself supports Python 3.10+.
-
 ```bash
 # Create and activate a virtual environment
 python -m venv venv
@@ -33,6 +31,8 @@ source venv/bin/activate  # On Windows: venv\Scripts\activate
 pip install -e ".[dev]"
 ```
 
+> **Note:** The development environment requires Python 3.12+, because the documentation tools in the `dev` extra (Sphinx 9.1) don't support Python 3.11. The package itself supports Python 3.11+.
+
 ### Create a Branch
 
 ```bash
@@ -110,7 +110,7 @@ Types include:
 
 1. Update the README.md or documentation with details of changes if appropriate
 2. Update the CHANGELOG.md with details of changes
-3. The PR should work for Python 3.10 and above
+3. The PR should work for Python 3.11 and above
 4. PRs require approval from at least one maintainer
 5. Once approved, a maintainer will merge your PR
 

{pyuspto-0.5.7/src/pyUSPTO.egg-info → pyuspto-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyUSPTO
-Version: 0.5.7
+Version: 0.6.0
 Summary: A Modern Python client for accessing the United States Patent and Trademark Office (USPTO) Open Data Portal (ODP) APIs.
 Author-email: Andrew Piechocki <apiechocki@dunlapcodding.com>
 License-Expression: MIT
@@ -11,11 +11,11 @@ Project-URL: Documentation, https://pyuspto.readthedocs.io/en/latest/
 Project-URL: releasenotes, https://github.com/DunlapCoddingPC/pyUSPTO/releases/latest
 Keywords: uspto,patent,odp,client,bulk data,patent data
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -37,18 +37,16 @@ Classifier: Topic :: Office/Business
 Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests>=2.32.5
-Requires-Dist: typing-extensions>=4.15.0; python_version < "3.11"
 Requires-Dist: tzdata>=2026.1
 Requires-Dist: urllib3>=2.0.0
 Provides-Extra: test
 Requires-Dist: pytest>=9.0.2; extra == "test"
 Requires-Dist: pytest-cov>=7.0.0; extra == "test"
 Requires-Dist: pytest-mock>=3.15.1; extra == "test"
-Requires-Dist: typing_extensions>=4.15.0; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx>=9.1.0; extra == "docs"
 Requires-Dist: sphinx-rtd-theme>=3.1.0; extra == "docs"
@@ -69,27 +67,27 @@ Dynamic: license-file
 
 [![PyPI version](https://badge.fury.io/py/pyUSPTO.svg)](https://badge.fury.io/py/pyUSPTO)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
 [![Read the Docs](https://img.shields.io/readthedocs/pyuspto)](https://pyuspto.readthedocs.io/en/latest/)
 [![PyPI Downloads](https://static.pepy.tech/personalized-badge/pyuspto?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLUE&right_color=GREY&left_text=downloads)](https://pepy.tech/projects/pyuspto)
 
-A Python client library for interacting with the United Stated Patent and Trademark Office (USPTO) [Open Data Portal](https://data.uspto.gov/home) APIs.
+A Python client library for interacting with the United States Patent and Trademark Office (USPTO) [Open Data Portal](https://data.uspto.gov/home) APIs.
 
-This package provides clients for interacting with the USPTO Bulk Data API, Patent Data API, Final Petition Decisions API, PTAB (Patent Trial and Appeal Board) APIs, Enriched Citations API, Office Action Text Retrieval API, Office Action Rejections API, and Office Action Citations API.
+This package provides clients for interacting with the USPTO Bulk Data API, Patent Data API, Petition Decisions API, PTAB (Patent Trial and Appeal Board) APIs, Enriched Citations API, Office Action Text Retrieval API, Office Action Rejections API, and Office Action Citations API.
 
 > [!IMPORTANT]
-> The USPTO is in the process of moving their Developer API. This package is only concerned with the new API. The [old API](https://developer.uspto.gov/) was officially retired at the end of 2025; however, some products have not yet been fully transitioned to the Open Data Portal API. The USPTO expects the remaining products to be transitioned to the Open Data Portal in early 2026.
+> The USPTO has moved the Developer API to the Open Data Portal. This package is only concerned with the USPTO Open Data Portal API. The old API (`https://developer.uspto.gov/`) was formally decommissioned on June 5, 2026.
 
 ## Quick Start
 
-**Requirements**: Python ≥3.10
+**Requirements**: Python ≥3.11
 
 ```bash
 pip install pyUSPTO
 ```
 
 > [!IMPORTANT]
-> You must have an API key for the [USPTO Open Data Portal API](https://data.uspto.gov/myodp/landing).
+> You must have an API key for the [USPTO Open Data Portal](https://data.uspto.gov/home) APIs. You can get one from the [Manage API Key](https://data.uspto.gov/apikey) page.
 
 ```python
 from pyUSPTO import PatentDataClient, USPTOConfig
@@ -128,7 +126,7 @@ from pyUSPTO import (
     OACitationsClient,
     OARejectionsClient,
     PatentDataClient,
-    FinalPetitionDecisionsClient,
+    PetitionDecisionsClient,
     PTABTrialsClient,
     PTABAppealsClient,
     PTABInterferencesClient,
@@ -140,7 +138,7 @@ config = USPTOConfig.from_env()
 
 patent_client = PatentDataClient(config=config)
 bulk_client = BulkDataClient(config=config)
-petition_client = FinalPetitionDecisionsClient(config=config)
+petition_client = PetitionDecisionsClient(config=config)
 trials_client = PTABTrialsClient(config=config)
 appeals_client = PTABAppealsClient(config=config)
 interferences_client = PTABInterferencesClient(config=config)
@@ -167,7 +165,7 @@ config = USPTOConfig(api_key="your_api_key_here")
 
 1. [Patent Data API](#patent-data-api)
 2. [Bulk Data API](#bulk-data-api)
-3. [Final Petition Decisions API](#final-petition-decisions-api)
+3. [Petition Decisions API](#petition-decisions-api)
 4. [PTAB Trials API](#ptab-trials-api)
 5. [PTAB Appeals API](#ptab-appeals-api)
 6. [PTAB Interferences API](#ptab-interferences-api)
@@ -231,13 +229,13 @@ print(f"Product: {product.product_title_text}")
 
 See [`examples/bulk_data_example.py`](examples/bulk_data_example.py) for detailed examples including file downloads and archive extraction.
 
-### Final Petition Decisions API
+### Petition Decisions API
 
 ```python
-from pyUSPTO import FinalPetitionDecisionsClient, USPTOConfig
+from pyUSPTO import PetitionDecisionsClient, USPTOConfig
 
 config = USPTOConfig(api_key="your_api_key_here")
-client = FinalPetitionDecisionsClient(config=config)
+client = PetitionDecisionsClient(config=config)
 
 # Search for petition decisions
 response = client.search_decisions(
@@ -250,7 +248,19 @@ response = client.search_decisions(limit=1)
 if response.count > 0:
     decision_id = response.petition_decision_data_bag[0].petition_decision_record_identifier
     decision = client.get_decision_by_id(decision_id)
-    print(f"Decision Type: {decision.decision_type_code}")
+    print(f"Decision Type: {decision.decided_petition_type_code_description_text}")
+```
+
+`PetitionDecisionsClient` returns final and non-final decisions. For final decisions only, use `FinalPetitionDecisionsClient`, which restricts every search, pagination, and `download_decisions` call to final decisions and returns `None` from `get_decision_by_id` for a non-final decision:
+
+```python
+from pyUSPTO import FinalPetitionDecisionsClient
+
+final_client = FinalPetitionDecisionsClient(config=config)
+response = final_client.search_decisions(
+    decision_date_from_q="2023-01-01", decision_date_to_q="2023-12-31", limit=5
+)
+print(f"Found {response.count} final decisions from 2023.")
 ```
 
 See [`examples/petition_decisions_example.py`](examples/petition_decisions_example.py) for detailed examples including downloading decision documents.

{pyuspto-0.5.7 → pyuspto-0.6.0}/README.md

@@ -2,27 +2,27 @@
 
 [![PyPI version](https://badge.fury.io/py/pyUSPTO.svg)](https://badge.fury.io/py/pyUSPTO)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
 [![Read the Docs](https://img.shields.io/readthedocs/pyuspto)](https://pyuspto.readthedocs.io/en/latest/)
 [![PyPI Downloads](https://static.pepy.tech/personalized-badge/pyuspto?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLUE&right_color=GREY&left_text=downloads)](https://pepy.tech/projects/pyuspto)
 
-A Python client library for interacting with the United Stated Patent and Trademark Office (USPTO) [Open Data Portal](https://data.uspto.gov/home) APIs.
+A Python client library for interacting with the United States Patent and Trademark Office (USPTO) [Open Data Portal](https://data.uspto.gov/home) APIs.
 
-This package provides clients for interacting with the USPTO Bulk Data API, Patent Data API, Final Petition Decisions API, PTAB (Patent Trial and Appeal Board) APIs, Enriched Citations API, Office Action Text Retrieval API, Office Action Rejections API, and Office Action Citations API.
+This package provides clients for interacting with the USPTO Bulk Data API, Patent Data API, Petition Decisions API, PTAB (Patent Trial and Appeal Board) APIs, Enriched Citations API, Office Action Text Retrieval API, Office Action Rejections API, and Office Action Citations API.
 
 > [!IMPORTANT]
-> The USPTO is in the process of moving their Developer API. This package is only concerned with the new API. The [old API](https://developer.uspto.gov/) was officially retired at the end of 2025; however, some products have not yet been fully transitioned to the Open Data Portal API. The USPTO expects the remaining products to be transitioned to the Open Data Portal in early 2026.
+> The USPTO has moved the Developer API to the Open Data Portal. This package is only concerned with the USPTO Open Data Portal API. The old API (`https://developer.uspto.gov/`) was formally decommissioned on June 5, 2026.
 
 ## Quick Start
 
-**Requirements**: Python ≥3.10
+**Requirements**: Python ≥3.11
 
 ```bash
 pip install pyUSPTO
 ```
 
 > [!IMPORTANT]
-> You must have an API key for the [USPTO Open Data Portal API](https://data.uspto.gov/myodp/landing).
+> You must have an API key for the [USPTO Open Data Portal](https://data.uspto.gov/home) APIs. You can get one from the [Manage API Key](https://data.uspto.gov/apikey) page.
 
 ```python
 from pyUSPTO import PatentDataClient, USPTOConfig
@@ -61,7 +61,7 @@ from pyUSPTO import (
     OACitationsClient,
     OARejectionsClient,
     PatentDataClient,
-    FinalPetitionDecisionsClient,
+    PetitionDecisionsClient,
     PTABTrialsClient,
     PTABAppealsClient,
     PTABInterferencesClient,
@@ -73,7 +73,7 @@ config = USPTOConfig.from_env()
 
 patent_client = PatentDataClient(config=config)
 bulk_client = BulkDataClient(config=config)
-petition_client = FinalPetitionDecisionsClient(config=config)
+petition_client = PetitionDecisionsClient(config=config)
 trials_client = PTABTrialsClient(config=config)
 appeals_client = PTABAppealsClient(config=config)
 interferences_client = PTABInterferencesClient(config=config)
@@ -100,7 +100,7 @@ config = USPTOConfig(api_key="your_api_key_here")
 
 1. [Patent Data API](#patent-data-api)
 2. [Bulk Data API](#bulk-data-api)
-3. [Final Petition Decisions API](#final-petition-decisions-api)
+3. [Petition Decisions API](#petition-decisions-api)
 4. [PTAB Trials API](#ptab-trials-api)
 5. [PTAB Appeals API](#ptab-appeals-api)
 6. [PTAB Interferences API](#ptab-interferences-api)
@@ -164,13 +164,13 @@ print(f"Product: {product.product_title_text}")
 
 See [`examples/bulk_data_example.py`](examples/bulk_data_example.py) for detailed examples including file downloads and archive extraction.
 
-### Final Petition Decisions API
+### Petition Decisions API
 
 ```python
-from pyUSPTO import FinalPetitionDecisionsClient, USPTOConfig
+from pyUSPTO import PetitionDecisionsClient, USPTOConfig
 
 config = USPTOConfig(api_key="your_api_key_here")
-client = FinalPetitionDecisionsClient(config=config)
+client = PetitionDecisionsClient(config=config)
 
 # Search for petition decisions
 response = client.search_decisions(
@@ -183,7 +183,19 @@ response = client.search_decisions(limit=1)
 if response.count > 0:
     decision_id = response.petition_decision_data_bag[0].petition_decision_record_identifier
     decision = client.get_decision_by_id(decision_id)
-    print(f"Decision Type: {decision.decision_type_code}")
+    print(f"Decision Type: {decision.decided_petition_type_code_description_text}")
+```
+
+`PetitionDecisionsClient` returns final and non-final decisions. For final decisions only, use `FinalPetitionDecisionsClient`, which restricts every search, pagination, and `download_decisions` call to final decisions and returns `None` from `get_decision_by_id` for a non-final decision:
+
+```python
+from pyUSPTO import FinalPetitionDecisionsClient
+
+final_client = FinalPetitionDecisionsClient(config=config)
+response = final_client.search_decisions(
+    decision_date_from_q="2023-01-01", decision_date_to_q="2023-12-31", limit=5
+)
+print(f"Found {response.count} final decisions from 2023.")
 ```
 
 See [`examples/petition_decisions_example.py`](examples/petition_decisions_example.py) for detailed examples including downloading decision documents.

{pyuspto-0.5.7 → pyuspto-0.6.0}/docs/source/about.rst

@@ -16,8 +16,9 @@ grants, bulk data downloads, PTAB proceedings, Office Actions, and more.
 
 .. note::
 
-   An API key is required to use the ODP APIs. You can register for one at the
-   `USPTO Open Data Portal <https://data.uspto.gov/myodp/landing>`_.
+   An API key is required to use the ODP APIs. You can register for one on the
+   `Manage API Key <https://data.uspto.gov/apikey>`_ page of the
+   `USPTO Open Data Portal <https://data.uspto.gov/home>`_.
 
 Available Clients
 -----------------
@@ -34,8 +35,10 @@ pyUSPTO provides the following clients:
      - Search patent applications and grants, retrieve file wrappers and Image File Wrapper (IFW) documents, and download individual documents and publications.
    * - :class:`~pyUSPTO.BulkDataClient`
      - Search and download bulk data products from the ODP Bulk Dataset Directory, including patent grants, applications, assignments, and research datasets.
+   * - :class:`~pyUSPTO.PetitionDecisionsClient`
+     - Search and retrieve petition decisions issued by the USPTO.
    * - :class:`~pyUSPTO.FinalPetitionDecisionsClient`
-     - Search and retrieve Final Petition Decisions issued by the USPTO Director.
+     - Same as PetitionDecisionsClient, limited to final petition decisions.
    * - :class:`~pyUSPTO.PTABTrialsClient`
      - Search PTAB trial proceedings (IPR, PGR, CBM, and derivation), documents, and decisions.
    * - :class:`~pyUSPTO.PTABAppealsClient`
@@ -54,5 +57,5 @@ pyUSPTO provides the following clients:
 Requirements
 ------------
 
-- Python 3.10 or higher
+- Python 3.11 or higher
 - A USPTO Open Data Portal API key

{pyuspto-0.5.7 → pyuspto-0.6.0}/docs/source/configuration.rst

@@ -4,4 +4,4 @@ Configuration
 .. include:: ../../README.md
    :parser: myst_parser.sphinx_
    :start-after: ## Configuration
-   :end-before: ## API Usage Examples
+   :end-before: ## Client Usage Examples

pyuspto-0.6.0/docs/source/examples/oa_rejections.rst

@@ -0,0 +1,6 @@
+OA Rejections Example
+=====================
+
+.. literalinclude:: ../../../examples/oa_rejections_example.py
+   :language: python
+   :linenos:

pyuspto-0.6.0/docs/source/installation.rst

@@ -0,0 +1,42 @@
+Installation
+============
+
+pyUSPTO requires Python 3.11 or higher. Install the latest release from
+`PyPI <https://pypi.org/project/pyUSPTO/>`_:
+
+.. code-block:: bash
+
+   pip install pyUSPTO
+
+If you use `uv <https://docs.astral.sh/uv/>`_, add pyUSPTO to your project
+with:
+
+.. code-block:: bash
+
+   uv add pyUSPTO
+
+or install it into a virtual environment with ``uv pip install pyUSPTO``.
+
+To use the library you will also need a USPTO Open Data Portal API key — see
+:doc:`about` for how to get one.
+
+Development Installation
+------------------------
+
+To work on pyUSPTO itself, clone the repository and install it in editable
+mode with the development dependencies:
+
+.. code-block:: bash
+
+   git clone https://github.com/DunlapCoddingPC/pyUSPTO.git
+   cd pyUSPTO
+   pip install -e ".[dev]"
+
+.. note::
+
+   The development environment requires Python 3.12+, because the
+   documentation tools in the ``dev`` extra (Sphinx 9.1) don't support
+   Python 3.11. The package itself supports Python 3.11+.
+
+See the :doc:`contributing guidelines <development>` for the full development
+workflow, including running tests and linting.

{pyuspto-0.5.7 → pyuspto-0.6.0}/examples/ifw_example.py

@@ -39,7 +39,7 @@ if pat_no_ifw and pat_no_ifw.application_meta_data:
     print(f"  IFW found via patent number: {patent_number}")
 
 # Publication number
-publication_number = "*20150157873*"
+publication_number = "20150157873"
 pub_no_ifw = client.get_IFW_metadata(publication_number=publication_number)
 if pub_no_ifw and pub_no_ifw.application_meta_data:
     print(f"Title: {pub_no_ifw.application_meta_data.invention_title}")

{pyuspto-0.5.7 → pyuspto-0.6.0}/examples/petition_decisions_example.py

@@ -1,13 +1,17 @@
-"""Example usage of pyUSPTO for Final Petition Decisions.
+"""Example usage of pyUSPTO for Petition Decisions.
 
-Demonstrates the FinalPetitionDecisionsClient for searching decisions,
+Demonstrates the PetitionDecisionsClient for searching decisions,
 downloading decision data, and paginating results.
 """
 
 import json
 import os
 
-from pyUSPTO import FinalPetitionDecisionsClient, PetitionDecisionDownloadResponse, USPTOConfig
+from pyUSPTO import (
+    PetitionDecisionDownloadResponse,
+    PetitionDecisionsClient,
+    USPTOConfig,
+)
 
 DEST_PATH = "./notes/download-example"
 
@@ -18,7 +22,7 @@ if api_key == "YOUR_API_KEY_HERE":
         "API key is not set. Set the USPTO_API_KEY environment variable."
     )
 config = USPTOConfig(api_key=api_key)
-client = FinalPetitionDecisionsClient(config=config)
+client = PetitionDecisionsClient(config=config)
 
 print("-" * 40)
 print("Example 1: Basic search")
@@ -31,7 +35,7 @@ print(f"Displaying first {len(response.petition_decision_data_bag)} decisions:")
 for decision in response.petition_decision_data_bag:
     print(f"\n  Decision ID: {decision.petition_decision_record_identifier}")
     print(f"  Application Number: {decision.application_number_text}")
-    print(f"  Decision Type: {decision.decision_type_code}")
+    print(f"  Decision Type: {decision.decided_petition_type_code_description_text}")
     print(f"  Decision Date: {decision.decision_date}")
     print(f"  Technology Center: {decision.technology_center}")
 
@@ -53,13 +57,13 @@ print("-" * 40)
 print("Example 2: Search with custom query")
 print("-" * 40)
 
-response = client.search_decisions(query="decisionTypeCode:C", limit=3)
-print(f"Found {response.count} decisions with C type.")
+response = client.search_decisions(query="decidedPetitionTypeCode:C", limit=3)
+print(f"Found {response.count} DENIED decisions.")
 print(f"Showing {len(response.petition_decision_data_bag)} results:")
 
 for decision in response.petition_decision_data_bag:
     print(
-        f"  - {decision.petition_decision_record_identifier}: {decision.decision_type_code}"
+        f"  - {decision.petition_decision_record_identifier}: {decision.decided_petition_type_code}"
     )
 
 print("-" * 40)
@@ -96,7 +100,9 @@ if response.count > 0:
             print(f"  ID: {decision.petition_decision_record_identifier}")
             print(f"  Application: {decision.application_number_text}")
             print(f"  Patent: {decision.patent_number}")
-            print(f"  Decision Type: {decision.decision_type_code}")
+            print(
+                f"  Decision Type: {decision.decided_petition_type_code_description_text}"
+            )
             print(f"  Decision Date: {decision.decision_date}")
             print(f"  Technology Center: {decision.technology_center}")
             print(f"  Group Art Unit: {decision.group_art_unit_number}")
@@ -117,7 +123,6 @@ if response.count > 0:
                     print(f"    - Doc ID: {doc.document_identifier}")
                     print(f"      Date: {doc.official_date}")
                     print(f"      Doc. Code: {doc.document_code_description_text}")
-                    print(f"      Direction: {doc.direction_category}")
                     if doc.download_option_bag:
                         print(
                             f"      Download Options: {len(doc.download_option_bag)}"
@@ -157,11 +162,19 @@ print("Example 6: Paginate through results")
 print("-" * 40)
 
 max_items = 30
+page_size = 10
 count = 0
 for decision in client.paginate_decisions(
-    limit=10, query="decisionDate:[2023-01-01 TO 2023-12-31]"
+    limit=page_size, query="decisionDate:[2023-01-01 TO 2023-12-31]"
 ):
+    if count % page_size == 0:
+        print(f"  Page {count // page_size + 1} (offset {count}):")
     count += 1
+    print(
+        f"    {count}. {decision.application_number_text} - "
+        f"{decision.decided_petition_type_code_description_text}"
+    )
+
     if count >= max_items:
         print(f"  ... (stopping at {max_items} items)")
         break
@@ -177,9 +190,7 @@ response = client.search_decisions(limit=20)
 
 document_found = False
 for decision in response.petition_decision_data_bag:
-    d = client.get_decision_by_id(
-        decision.petition_decision_record_identifier, include_documents=True
-    )
+    d = client.get_decision_by_id(decision.petition_decision_record_identifier)
     print(
         f"Getting docs for patent: {d.invention_title} with id: {d.petition_decision_record_identifier}"
     )  # type: ignore
@@ -198,6 +209,7 @@ for decision in response.petition_decision_data_bag:
                 file_path = client.download_petition_document(
                     download_option=download_option,
                     destination=DEST_PATH,
+                    overwrite=True,
                 )
                 print(f"Downloaded to: {file_path}")
 

{pyuspto-0.5.7 → pyuspto-0.6.0}/pyproject.toml

@@ -9,16 +9,16 @@ authors = [
     { name = "Andrew Piechocki", email = "apiechocki@dunlapcodding.com" },
 ]
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 license = "MIT"
 license-files = ["LICENSE*"]
 classifiers = [
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
     "Operating System :: OS Independent",
     "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
@@ -45,7 +45,6 @@ classifiers = [
 keywords = ["uspto", "patent", "odp", "client", "bulk data", "patent data"]
 dependencies = [
     "requests>=2.32.5",
-    "typing-extensions>=4.15.0; python_version < '3.11'",
     "tzdata>=2026.1",
     "urllib3>=2.0.0",
 ]
@@ -56,7 +55,6 @@ test = [
     "pytest>=9.0.2",
     "pytest-cov>=7.0.0",
     "pytest-mock>=3.15.1",
-    "typing_extensions>=4.15.0",
 ]
 docs = [
     "sphinx>=9.1.0",
@@ -89,7 +87,7 @@ pyUSPTO = ["py.typed"]
 
 [tool.ruff]
 line-length = 88
-target-version = "py310"
+target-version = "py311"
 
 [tool.ruff.lint]
 # Enable pycodestyle (E), Pyflakes (F), pydocstyle (D), isort (I), and pyupgrade (UP)