pyUSPTO 0.4.5__tar.gz → 0.5.1__tar.gz

pyuspto-0.5.1/.github/workflows/codeql.yml

@@ -0,0 +1,99 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '41 13 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: python
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    # Add any setup steps before running the `github/codeql-action/init` action.
+    # This includes steps like installing compilers or runtimes (`actions/setup-node`
+    # or others). This is typically only required for manual builds.
+    # - name: Setup runtime (example)
+    #   uses: actions/setup-example@v1
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v4
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        queries: security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - name: Run manual build steps
+      if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v4
+      with:
+        category: "/language:${{matrix.language}}"

{pyuspto-0.4.5 → pyuspto-0.5.1}/.github/workflows/python-tests.yml

@@ -32,7 +32,7 @@ jobs:
           pytest tests/ --cov=src/pyUSPTO
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v6
         with:
           fail_ci_if_error: false
 

{pyuspto-0.4.5 → pyuspto-0.5.1}/.readthedocs.yaml

@@ -7,7 +7,7 @@ version: 2
 build:
   os: ubuntu-24.04
   tools:
-    python: "3.10"
+    python: "3.14"
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:

{pyuspto-0.4.5 → pyuspto-0.5.1}/CHANGELOG.md

@@ -5,7 +5,119 @@ 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.3.0] - TBD
+## [0.4.5] - 2026-03-11
+
+### Changed
+
+- **Refactor**: Split `_make_request` into three typed request methods:
+  - `_get_model` — returns parsed model `T`
+  - `_get_json` — returns `dict[str, Any]`
+  - `_stream_request` — returns `requests.Response`
+- Removed all `assert isinstance` runtime checks and `# type: ignore` annotations at 28 call sites
+- `DocumentBag`, `StatusCodeSearchResponse`, and `PetitionDecisionDownloadResponse` now conform to `FromDictProtocol` (`include_raw_data` parameter added to `from_dict`)
+
+### Fixed
+
+- PTAB appeals integration test query (`Appeal` → `REGULAR` for `applicationTypeCategory`)
+- Read the Docs build: updated Python from 3.10 to 3.14 to satisfy `myst-parser>=3.11` requirement
+
+## [0.4.4] - 2026-03-08
+
+### Added
+
+- `get_patent(patent_number)` — lookup `PatentFileWrapper` by granted patent number
+- `get_publication(publication_number)` — lookup by publication number
+- `get_pct(pct_number)` — lookup by PCT application or publication number (auto-detected)
+
+### Fixed
+
+- `sanitize_application_number` now strips leading zeros from PCT serial numbers
+
+## [0.4.3] - 2026-03-05
+
+### Added
+
+- `get_IFW` method for bulk downloading all documents in an application's IFW
+- `IFWResult` model with document map and optional ZIP output
+- `get_IFW_metadata` now populates `document_bag` on the returned `PatentFileWrapper`
+- Example: searching CPC codes (#102)
+
+### Fixed
+
+- Auto-quote `classification_q` values containing spaces or slashes (#101)
+- Missing `typing_extensions` dependency
+- CI refactor to exclude dev requirements from install
+
+## [0.4.2] - 2026-02-26
+
+### Fixed
+
+- Quote multi-word values in query convenience parameters
+
+## [0.4.1] - 2026-02-25
+
+### Added
+
+- Download path validation and zip-bomb protection
+- Sanitize download filenames to prevent path traversal
+- Skip symlinks during archive extraction
+- Session lifecycle and extraction safety documentation
+
+### Changed
+
+- Enable retries for POST requests
+- Remove unused `utils.http` module and `ALLOWED_METHODS`
+- Enforce keyword-only arguments in `get_IFW_metadata`
+- Optimize tox deps and enable parallel
+
+## [0.4.0] - 2026-02-23
+
+### Changed
+
+- **Refactor**: Centralize session management in `USPTOConfig`
+- `FileData.file_date` changed to `datetime` type
+
+### Fixed
+
+- Prevent path traversal in archive extraction
+- Fix #79
+
+## [0.3.4] - 2026-01-11
+
+### Added
+
+- JSON parsing error handling
+- Pagination validation
+- Documentation for HTTP method restrictions and `include_raw_data` flag
+
+### Changed
+
+- Aligned backoff factor default
+
+## [0.3.3] - 2026-01-08
+
+### Changed
+
+- Bulk data client refactor (#40)
+
+## [0.3.2] - 2025-12-31
+
+### Changed
+
+- Refactor downloads (#35)
+- Configurable download chunk size
+- Session sharing across clients
+
+## [0.3.1] - 2025-12-15
+
+### Added
+
+- `paginate_decisions` POST support
+- Configurable download chunk size
+- Session sharing across clients
+- Bulk data endpoint updates
+
+## [0.3.0] - 2025-12-09
 
 ### Added
 

{pyuspto-0.4.5 → pyuspto-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyUSPTO
-Version: 0.4.5
+Version: 0.5.1
 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
@@ -75,7 +75,7 @@ Dynamic: license-file
 
 A Python client library for interacting with the United Stated 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, and PTAB (Patent Trial and Appeal Board) 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.
 
 > [!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.
@@ -123,6 +123,10 @@ Then use it in your Python code:
 ```python
 from pyUSPTO import (
     BulkDataClient,
+    EnrichedCitationsClient,
+    OAActionsClient,
+    OACitationsClient,
+    OARejectionsClient,
     PatentDataClient,
     FinalPetitionDecisionsClient,
     PTABTrialsClient,
@@ -140,6 +144,10 @@ petition_client = FinalPetitionDecisionsClient(config=config)
 trials_client = PTABTrialsClient(config=config)
 appeals_client = PTABAppealsClient(config=config)
 interferences_client = PTABInterferencesClient(config=config)
+citations_client = EnrichedCitationsClient(config=config)
+oa_client = OAActionsClient(config=config)
+oa_citations_client = OACitationsClient(config=config)
+rejections_client = OARejectionsClient(config=config)
 ```
 
 ### Direct API Key
@@ -302,6 +310,79 @@ print(f"Found {response.count} interference decisions since 2023")
 
 See [`examples/ptab_interferences_example.py`](examples/ptab_interferences_example.py) for detailed examples including searching by party name and outcome.
 
+### Enriched Citations API
+
+```python
+from pyUSPTO import EnrichedCitationsClient, USPTOConfig
+
+config = USPTOConfig(api_key="your_api_key_here")
+client = EnrichedCitationsClient(config=config)
+
+# Search for enriched citations by technology center
+response = client.search_citations(
+    tech_center_q="1700",
+    rows=5,
+)
+print(f"Found {response.count} citations from TC 1700")
+```
+
+See [`examples/enriched_citations_example.py`](examples/enriched_citations_example.py) for detailed examples including searching by application number and citation category.
+
+### Office Action Text Retrieval API
+
+```python
+from pyUSPTO import OAActionsClient, USPTOConfig
+
+config = USPTOConfig(api_key="your_api_key_here")
+client = OAActionsClient(config=config)
+
+# Search for office actions by technology center
+response = client.search(
+    tech_center_q="1700",
+    rows=5,
+)
+print(f"Found {response.count} office actions from TC 1700")
+```
+
+See [`examples/oa_actions_example.py`](examples/oa_actions_example.py) for detailed examples including searching by document code and paginating results.
+
+### Office Action Rejections API
+
+```python
+from pyUSPTO import OARejectionsClient, USPTOConfig
+
+config = USPTOConfig(api_key="your_api_key_here")
+client = OARejectionsClient(config=config)
+
+# Search for rejections by application number
+response = client.search(
+    patent_application_number_q="12190351",
+    rows=5,
+)
+print(f"Found {response.count} rejection records for application 12190351")
+```
+
+See [`examples/oa_rejections_example.py`](examples/oa_rejections_example.py) for detailed examples including searching by document code and inspecting rejection flags.
+
+### Office Action Citations API
+
+```python
+from pyUSPTO import OACitationsClient, USPTOConfig
+
+config = USPTOConfig(api_key="your_api_key_here")
+client = OACitationsClient(config=config)
+
+# Search for citations by legal section code
+response = client.search(
+    legal_section_code_q="103",
+    tech_center_q="2800",
+    rows=5,
+)
+print(f"Found {response.count} section 103 citations in tech center 2800")
+```
+
+See [`examples/oa_citations_example.py`](examples/oa_citations_example.py) for detailed examples including searching by examiner-cited indicator and paginating results.
+
 ## Documentation
 
 Full documentation may be found on [Read the Docs](https://pyuspto.readthedocs.io/).

{pyuspto-0.4.5 → pyuspto-0.5.1}/README.md

@@ -8,7 +8,7 @@
 
 A Python client library for interacting with the United Stated 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, and PTAB (Patent Trial and Appeal Board) 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.
 
 > [!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.
@@ -56,6 +56,10 @@ Then use it in your Python code:
 ```python
 from pyUSPTO import (
     BulkDataClient,
+    EnrichedCitationsClient,
+    OAActionsClient,
+    OACitationsClient,
+    OARejectionsClient,
     PatentDataClient,
     FinalPetitionDecisionsClient,
     PTABTrialsClient,
@@ -73,6 +77,10 @@ petition_client = FinalPetitionDecisionsClient(config=config)
 trials_client = PTABTrialsClient(config=config)
 appeals_client = PTABAppealsClient(config=config)
 interferences_client = PTABInterferencesClient(config=config)
+citations_client = EnrichedCitationsClient(config=config)
+oa_client = OAActionsClient(config=config)
+oa_citations_client = OACitationsClient(config=config)
+rejections_client = OARejectionsClient(config=config)
 ```
 
 ### Direct API Key
@@ -235,6 +243,79 @@ print(f"Found {response.count} interference decisions since 2023")
 
 See [`examples/ptab_interferences_example.py`](examples/ptab_interferences_example.py) for detailed examples including searching by party name and outcome.
 
+### Enriched Citations API
+
+```python
+from pyUSPTO import EnrichedCitationsClient, USPTOConfig
+
+config = USPTOConfig(api_key="your_api_key_here")
+client = EnrichedCitationsClient(config=config)
+
+# Search for enriched citations by technology center
+response = client.search_citations(
+    tech_center_q="1700",
+    rows=5,
+)
+print(f"Found {response.count} citations from TC 1700")
+```
+
+See [`examples/enriched_citations_example.py`](examples/enriched_citations_example.py) for detailed examples including searching by application number and citation category.
+
+### Office Action Text Retrieval API
+
+```python
+from pyUSPTO import OAActionsClient, USPTOConfig
+
+config = USPTOConfig(api_key="your_api_key_here")
+client = OAActionsClient(config=config)
+
+# Search for office actions by technology center
+response = client.search(
+    tech_center_q="1700",
+    rows=5,
+)
+print(f"Found {response.count} office actions from TC 1700")
+```
+
+See [`examples/oa_actions_example.py`](examples/oa_actions_example.py) for detailed examples including searching by document code and paginating results.
+
+### Office Action Rejections API
+
+```python
+from pyUSPTO import OARejectionsClient, USPTOConfig
+
+config = USPTOConfig(api_key="your_api_key_here")
+client = OARejectionsClient(config=config)
+
+# Search for rejections by application number
+response = client.search(
+    patent_application_number_q="12190351",
+    rows=5,
+)
+print(f"Found {response.count} rejection records for application 12190351")
+```
+
+See [`examples/oa_rejections_example.py`](examples/oa_rejections_example.py) for detailed examples including searching by document code and inspecting rejection flags.
+
+### Office Action Citations API
+
+```python
+from pyUSPTO import OACitationsClient, USPTOConfig
+
+config = USPTOConfig(api_key="your_api_key_here")
+client = OACitationsClient(config=config)
+
+# Search for citations by legal section code
+response = client.search(
+    legal_section_code_q="103",
+    tech_center_q="2800",
+    rows=5,
+)
+print(f"Found {response.count} section 103 citations in tech center 2800")
+```
+
+See [`examples/oa_citations_example.py`](examples/oa_citations_example.py) for detailed examples including searching by examiner-cited indicator and paginating results.
+
 ## Documentation
 
 Full documentation may be found on [Read the Docs](https://pyuspto.readthedocs.io/).

pyuspto-0.5.1/docs/source/api/clients/enriched_citations.rst

@@ -0,0 +1,7 @@
+Enriched Citations Client
+=========================
+
+.. automodule:: pyUSPTO.clients.enriched_citations
+   :members:
+   :undoc-members:
+   :show-inheritance:

{pyuspto-0.4.5 → pyuspto-0.5.1}/docs/source/api/clients/index.rst

@@ -5,6 +5,10 @@ Clients
    :maxdepth: 2
 
    bulk_data
+   enriched_citations
+   oa_actions
+   oa_citations
+   oa_rejections
    patent_data
    petition_decisions
    ptab_appeals

pyuspto-0.5.1/docs/source/api/clients/oa_actions.rst

@@ -0,0 +1,7 @@
+OA Actions Client
+=================
+
+.. automodule:: pyUSPTO.clients.oa_actions
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyuspto-0.5.1/docs/source/api/clients/oa_citations.rst

@@ -0,0 +1,7 @@
+OA Citations Client
+===================
+
+.. automodule:: pyUSPTO.clients.oa_citations
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyuspto-0.5.1/docs/source/api/clients/oa_rejections.rst

@@ -0,0 +1,7 @@
+Office Action Rejections Client
+===============================
+
+.. automodule:: pyUSPTO.clients.oa_rejections
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyuspto-0.5.1/docs/source/api/models/enriched_citations.rst

@@ -0,0 +1,7 @@
+Enriched Citations
+==================
+
+.. automodule:: pyUSPTO.models.enriched_citations
+   :members:
+   :undoc-members:
+   :show-inheritance:

{pyuspto-0.4.5 → pyuspto-0.5.1}/docs/source/api/models/index.rst

@@ -6,6 +6,10 @@ Models
 
    base
    bulk_data
+   enriched_citations
+   oa_actions
+   oa_citations
+   oa_rejections
    patent_data
    petition_decisions
    ptab

pyuspto-0.5.1/docs/source/api/models/oa_actions.rst

@@ -0,0 +1,7 @@
+OA Actions Models
+=================
+
+.. automodule:: pyUSPTO.models.oa_actions
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyuspto-0.5.1/docs/source/api/models/oa_citations.rst

@@ -0,0 +1,7 @@
+OA Citations Models
+===================
+
+.. automodule:: pyUSPTO.models.oa_citations
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyuspto-0.5.1/docs/source/api/models/oa_rejections.rst

@@ -0,0 +1,7 @@
+Office Action Rejections Models
+================================
+
+.. automodule:: pyUSPTO.models.oa_rejections
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyuspto-0.5.1/docs/source/examples/enriched_citations.rst

@@ -0,0 +1,6 @@
+Enriched Citations Example
+==========================
+
+.. literalinclude:: ../../../examples/enriched_citations_example.py
+   :language: python
+   :linenos:

{pyuspto-0.4.5 → pyuspto-0.5.1}/docs/source/examples/index.rst

@@ -5,6 +5,10 @@ Examples
    :maxdepth: 2
 
    bulk_data
+   enriched_citations
+   oa_actions
+   oa_citations
+   oa_rejections
    patent_data
    ifw_example
    petition_decisions

pyuspto-0.5.1/docs/source/examples/oa_actions.rst

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

pyuspto-0.5.1/docs/source/examples/oa_citations.rst

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

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

@@ -0,0 +1,6 @@
+Office Action Rejections Examples
+==================================
+
+.. automodule:: examples.oa_rejections_example
+   :members:
+   :undoc-members: