pyproject.toml

[build-system]
requires = ["setuptools>=80", "wheel", "setuptools_scm>=8"]
build-backend = "setuptools.build_meta"

[project]
name = "pyUSPTO"
description = "A Modern Python client for accessing the United States Patent and Trademark Office (USPTO) Open Data Portal (ODP) APIs."
authors = [
    { name = "Andrew Piechocki", email = "apiechocki@dunlapcodding.com" },
]
readme = "README.md"
requires-python = ">=3.10"
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",
    "Operating System :: OS Independent",
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Intended Audience :: Developers",
    "Intended Audience :: Education",
    "Intended Audience :: Information Technology",
    "Intended Audience :: Legal Industry",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Other Audience",
    "Natural Language :: English",
    "Operating System :: MacOS",
    "Operating System :: POSIX :: Linux",
    "Topic :: Software Development :: Libraries",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Information Analysis",
    "Topic :: Education",
    "Topic :: Internet :: WWW/HTTP",
    "Topic :: Office/Business",
    "Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Utilities",
]

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",
]
dynamic = ["version"]

[project.optional-dependencies]
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",
    "sphinx-rtd-theme>=3.1.0",
    "sphinx-autodoc-typehints>=3.9.5",
    "sphinx-copybutton>=0.5.2",
    "myst-parser>=5.0.0",
]
lint = ["mypy>=1.19.0", "types-requests>=2.32.4", "ruff>=0.15.0"]
dev = ["pyUSPTO[test]", "pyUSPTO[docs]", "pyUSPTO[lint]"]

[project.urls]
GitHub = "https://github.com/DunlapCoddingPC/pyUSPTO"
homepage = "https://github.com/DunlapCoddingPC/pyUSPTO"
issues = "https://github.com/DunlapCoddingPC/pyUSPTO/issues"
Documentation = "https://pyuspto.readthedocs.io/en/latest/"
releasenotes = "https://github.com/DunlapCoddingPC/pyUSPTO/releases/latest"


[tool.setuptools_scm]

[tool.setuptools]
zip-safe = true

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools.package-data]
pyUSPTO = ["py.typed"]

[tool.ruff]
line-length = 88
target-version = "py310"

[tool.ruff.lint]
# Enable pycodestyle (E), Pyflakes (F), pydocstyle (D), isort (I), and pyupgrade (UP)
select = ["E", "F", "W", "D", "I", "UP"]
ignore = [
    "D203", # one-blank-line-before-class (conflicts with D211)
    "D213", # multi-line-summary-second-line (conflicts with D212)
    "E501", # line-too-long (handled by formatter where possible)
]

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["D"] # Ignore all pydocstyle rules in tests


[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ruff.lint.isort]
known-first-party = ["pyUSPTO"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
line-ending = "auto"

[tool.pytest.ini_options]
testpaths = ["tests"]
pythonpath = ["src"]

[tool.coverage.run]
source = ["src/pyUSPTO"]
omit = ["src/pyUSPTO/_version.py"]

[tool.coverage.report]
exclude_lines = [
    # Skip protocol definitions
    "class FromDictProtocol\\(Protocol\\):",
    "def from_dict\\(cls, data: Dict\\[str, Any\\]\\) -> Any:",
    "\\.\\.\\.",
    # Skip abstract methods 
    "@abstractmethod",
    # Skip defensive assertion code
    "raise NotImplementedError",
    # Skip type checking blocks
    "if TYPE_CHECKING:",
    "pass",
]

[tool.mypy]
mypy_path = "src"
python_version = "3.11"
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
disallow_incomplete_defs = true
check_untyped_defs = true
no_implicit_optional = true
strict_optional = true
warn_redundant_casts = true
warn_unused_ignores = true
warn_no_return = true
warn_unreachable = true

# Per-module configs
[[tool.mypy.overrides]]
module = "pyUSPTO.*"
disallow_untyped_defs = true

# Less strict for tests - allow untyped test functions
[[tool.mypy.overrides]]
module = "tests.*"
disallow_untyped_defs = false
disallow_incomplete_defs = false
disallow_untyped_decorators = false
check_untyped_defs = false
warn_unused_ignores = false
warn_unreachable = false

# Ignore missing stubs for third-party packages
[[tool.mypy.overrides]]
module = ["pytest.*", "pytest", "requests.*", "urllib3.*"]
ignore_missing_imports = true

[tool.deptry.per_rule_ignores]
DEP002 = [
    "tzdata",
    "pytest", "pytest-cov", "pytest-mock",
    "sphinx", "sphinx-rtd-theme", "sphinx-autodoc-typehints",
    "sphinx-copybutton", "myst-parser",
    "mypy", "types-requests",
    "ruff",
]