pyUSPTO 0.1.2__tar.gz

pyuspto-0.1.2/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,59 @@
+name: 🐞 Bug Report
+description: File a bug report.
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! Please fill out as much information as you can to help make sure the issue is resolved.
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version of pyUSPTO are you running?
+      placeholder: 0.x.y
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What Happened?
+      description: A clear and concise description of what the bug is. Also tell us, what step can reproduce the bug?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: textarea
+    id: what-expected
+    attributes:
+      label: What did you expect to happen?
+      description: Also tell us, do you have an idea why?
+      placeholder: Tell us what you see!
+    validations:
+      required: false
+  - type: textarea
+    id: mre
+    attributes:
+      label: Minimal Reproducible Code
+      description: | 
+        Please provide a minimal reproducible example of code causing the error. 
+        NOTE: This input will be automatically formatted into code, so no need for backticks.
+      render: python
+      placeholder: "from pyUSPTO import PatentDataClient"
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output, if any.
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). 
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

pyuspto-0.1.2/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📚 Documentation
+    url: https://github.com/DunlapCoddingPC/pyUSPTO/blob/main/README.md
+    about: Check the documentation for usage examples and API reference
+  - name: 💬 Discussions
+    url: https://github.com/DunlapCoddingPC/pyUSPTO/discussions
+    about: Ask questions and discuss ideas with the community

pyuspto-0.1.2/.github/ISSUE_TEMPLATE/documentation-updates.yml

@@ -0,0 +1,69 @@
+name: 📝 Documentation Update
+description: Suggest improvements to documentation
+title: "[DOCS] "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to help us update our Documentation!
+  - type: dropdown
+    id: issue-type
+    attributes:
+      label: What type of documentation issue are you seeing?
+      multiple: true
+      options:
+        - Outdated information
+        - Missing documentation
+        - Unclear/confusing content
+        - Broken links or formatting
+        - Example code not working
+        - API reference incorrect
+        - Typos or grammar issues
+    validations:
+      required: false
+  - type: dropdown
+    id: issue-location
+    attributes:
+      label: Where is the documentation issue located?
+      multiple: true
+      options:
+        - README.md
+        - Code examples (specify which file)
+        - API docstrings (specify module/class/method)
+        - Sphinx documentation (specify page)
+        - CONTRIBUTING.md
+        - Other (please specify) 
+    validations:
+      required: false
+  - type: input
+    id: issue-type-specifics
+    attributes:
+      label: Issue Type Specifics. You can insert a link to the problem area as well.
+      description: Provide requested specifics.
+      placeholder: ex. `CODE_OF_CONDUCT.md`
+    validations:
+      required: false
+  - type: textarea
+    id: current-problem
+    attributes:
+      label: What is the problem with the documentation?
+      description: Also tell us, what should be changed, added, or clarified??
+    validations:
+      required: true
+  - type: textarea
+    id: anything-else
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false
+  - type: checkboxes
+    id: pr-willing
+    attributes:
+      label: Willing to Submit Pull Request
+      description: Are you willing to submit a PR to fix this? 
+      options:
+        - label: I am willing to submit a PR to fix this.
+          required: false

pyuspto-0.1.2/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,32 @@
+name: 🎯 Feature Request
+description: Suggest an idea for this project
+title: "[FEAT] "
+labels: ["enhancement"]
+body:
+  - type: textarea
+    attributes:
+      label: Problem Related
+      description: | 
+        Is your feature request related to a problem? Please describe.
+        A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+        If this is related to an issue, please add the issue number.
+    validations:
+      required: false 
+  - type: textarea
+    attributes:
+      label: Expected Solution
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

pyuspto-0.1.2/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+## Description
+Brief description of what this PR does.
+
+## Type of Change
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Code refactoring
+
+## Testing
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I have tested this manually (if applicable)
+
+## Checklist
+- [ ] My code follows the project's style guidelines
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] Any dependent changes have been merged and published
+
+## Related Issues
+Closes #(issue number)
+
+## Additional Notes
+Any additional information that reviewers should know.

pyuspto-0.1.2/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+ 

pyuspto-0.1.2/.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,89 @@
+name: Publish Python distribution to PyPI and TestPyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_run:
+    workflows: ["Python Tests"]
+    types:
+      - completed
+    branches: [main]
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python distribution to PyPI
+    # only publish to PyPI on tag pushes and not tests
+    if: startsWith(github.ref, 'refs/tags/v')  && !startsWith(github.ref, 'test-')
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyUSPTO
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+    name: Publish Python distribution to TestPyPI
+    if: startsWith(github.ref, 'refs/tags/test-v')
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/pyUSPTO
+
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+        attestations: true
+        skip-existing: true
+        verbose: true

pyuspto-0.1.2/.github/workflows/python-tests.yml

@@ -0,0 +1,71 @@
+name: Python Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r requirements-dev.txt
+          pip install -e .
+
+      - name: Run tests
+        run: |
+          pytest tests/ --cov=src/pyUSPTO
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: false
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 black isort mypy
+
+      - name: Lint with flake8
+        run: |
+          flake8 src/pyUSPTO --count --select=E9,F63,F7,F82 --show-source --statistics
+
+      - name: Check formatting with black
+        run: |
+          black --check src/
+
+      - name: Check imports with isort
+        run: |
+          isort --check-only --profile black src/
+
+      - name: Type check with mypy
+        run: |
+          mypy src/pyUSPTO
+

pyuspto-0.1.2/.gitignore

@@ -0,0 +1,17 @@
+USPTO.code-workspace
+.vscode/
+downloads/
+.venv/
+*.egg-info/
+__pycache__
+mypy-guide.md
+docs-setup-guide.md
+PubPlan.md
+notes/*
+info/ODP-API-Query-Spec.pdf
+*.coverage
+.mypy_cache/
+.pytest_cache/
+src/pyUSPTO/_version.py
+download-example/*
+dist/

pyuspto-0.1.2/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+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).
+
+## [Unreleased]
+
+## [0.1.0] - TBD
+
+### Added
+
+- Initial release of pyUSPTO
+- Object Oriented Support for USPTO Patent Data API
+- Basic Support for USPTO Bulk Data API
+- Full type annotations and docstrings
+- Comprehensive test suite

pyuspto-0.1.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,29 @@
+# Code of Conduct
+
+## Our Standards
+
+We are committed to providing a welcoming and inclusive experience for everyone. We expect all contributors to:
+
+- Be respectful and considerate in communications
+- Focus on constructive feedback and collaboration
+- Respect differing viewpoints and experiences
+- Show empathy towards other community members
+
+## Unacceptable Behavior
+
+Examples of unacceptable behavior include:
+
+- Harassment, discrimination, or intimidation
+- Offensive comments or personal attacks
+- Trolling or deliberately disruptive behavior
+- Publishing others' private information without permission
+
+## Enforcement
+
+Instances of unacceptable behavior may be reported by contacting **apiechocki@dunlapcodding.com**. All complaints will be reviewed and investigated promptly and fairly.
+
+Project maintainers have the right to remove, edit, or reject contributions that do not align with this Code of Conduct.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

pyuspto-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,173 @@
+# Contributing to pyUSPTO
+
+We welcome contributions from the community! pyUSPTO is designed to be a useful tool for interacting with USPTO APIs, and your input helps make it better for everyone.
+
+## Ways to Contribute
+
+- **Code Contributions**: Implement new features, fix bugs, or improve performance
+- **Documentation**: Improve or expand documentation, add examples, fix typos
+- **Bug Reports**: Report bugs or suggest improvements
+- **Feature Requests**: Suggest new features or enhancements
+- **Community Support**: Help answer questions and support other users
+
+## Getting Started with Contributing
+
+### Fork the Repository
+
+```bash
+# Fork the repository on GitHub, then clone your fork
+git clone https://github.com/your-username/pyUSPTO.git
+cd pyUSPTO
+```
+
+### Set Up Development Environment
+
+```bash
+# Create and activate a virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install development dependencies
+pip install -r requirements.txt
+pip install -r requirements-dev.txt
+pip install -e .
+```
+
+### Create a Branch
+
+```bash
+# Create a branch for your contribution
+git checkout -b feature/your-feature-name
+```
+
+### Make Your Changes
+
+- Follow the code style guidelines
+- Add tests for new functionality
+- Update documentation as needed
+
+### Run Tests
+
+```bash
+# Run the test suite
+python -m pytest tests/ --cov=pyUSPTO --cov-report=term --cov-report=term-missing -vv
+
+# Run linting and type checking
+flake8 src/pyUSPTO --count --select=E9,F63,F7,F82,D100,D101,D102,D103 --show-source --statistics
+mypy ./src/
+
+# Correct Formatting 
+black .
+
+
+```
+
+### Submit a Pull Request
+
+- Push your changes to your fork
+- Submit a pull request from your branch to our main branch
+- Provide a clear description of the changes and any related issues
+
+## Code Style Guidelines
+
+- Follow PEP 8 for Python code style
+- Use type hints for all function parameters and return values
+- Write comprehensive docstrings for all functions, classes, and modules
+- Keep functions focused
+- Use meaningful variable and function names
+- Follow existing patterns in the codebase
+
+## Documentation Guidelines
+
+- Use docstrings for all public modules, functions, classes, and methods
+- Include type information in docstrings (already captured by type hints)
+- Document parameters, return values, and raised exceptions
+- Add examples where appropriate
+
+## Commit Message Guidelines
+
+We follow the Conventional Commits specification:
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Types include:
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Documentation changes
+- **style**: Code style changes (formatting, etc.)
+- **refactor**: Code changes that neither fix bugs nor add features
+- **test**: Adding or modifying tests
+- **chore**: Changes to the build process or auxiliary tools
+
+## Pull Request Process
+
+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
+4. PRs require approval from at least one maintainer
+5. Once approved, a maintainer will merge your PR
+
+## Testing
+
+The library includes unit and integration tests using pytest.
+
+### Running Tests
+
+1. **Run all tests (excluding integration tests)**:
+
+   ```bash
+   python -m pytest pyUSPTO/tests/
+   ```
+
+2. **Run tests with verbose output**:
+
+   ```bash
+   python -m pytest pyUSPTO/tests/ -v
+   ```
+
+3. **Run specific test files**:
+
+   ```bash
+   python -m pytest pyUSPTO/tests/test_base_client.py
+   python -m pytest pyUSPTO/tests/test_bulk_data.py
+   python -m pytest pyUSPTO/tests/test_patent_data.py
+   ```
+
+4. **Run specific test classes or methods**:
+
+   ```bash
+   python -m pytest pyUSPTO/tests/test_bulk_data.py::TestBulkDataClient
+   python -m pytest pyUSPTO/tests/test_bulk_data.py::TestBulkDataClient::test_download_file
+   ```
+
+5. **Run integration tests** (these are skipped by default):
+
+   ```bash
+   # On Windows
+   set ENABLE_INTEGRATION_TESTS=true
+   python -m pytest pyUSPTO/tests/test_integration.py -v
+
+   # On Unix/Linux/macOS
+   ENABLE_INTEGRATION_TESTS=true python -m pytest pyUSPTO/tests/test_integration.py -v
+   ```
+
+6. **Run tests with coverage report**:
+   ```bash
+   python -m pytest pyUSPTO/tests/ --cov=pyUSPTO
+   ```
+
+The tests are designed to use mocking to avoid making real API calls, making them fast and reliable. The integration tests are optional and will make real API calls to the USPTO API if enabled.
+
+## Versioning
+
+The project uses setuptools-scm for version management:
+
+- Versions are derived from git tags
+- When making releases, the maintainers will handle the versioning

pyuspto-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dunlap Codding, PC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.