pyproject.toml

# Build system requirements.
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"


# Project metadata.
[project]
name = "gfw-api-python-client"
version = "1.4.0"
description = "Python package for accessing data from Global Fishing Watch APIs."
readme = "README.md"
requires-python = ">=3.11"
license = { text = "Apache License 2.0" }
authors = [
  { name = "Global Fishing Watch", email = "apis@globalfishingwatch.org" },
]
maintainers = [
  { name = "Global Fishing Watch", email = "apis@globalfishingwatch.org" },
]
keywords = [
  "global fishing watch",
  "gfw",
  "apis",
  "api client",
  "fishing data",
  "satellite data",
  "vessel data",
  "marine data",
  "geospatial data",
  "ocean monitoring",
  "marine research",
  "marine conservation",
  "environmental research",
  "ocean sustainability",
  "ais",
  "vms",
]
classifiers = [
  "Development Status :: 4 - Beta",
  "Environment :: Console",
  "Framework :: Pydantic",
  "Framework :: Pydantic :: 2",
  "Intended Audience :: Developers",
  "Intended Audience :: Science/Research",
  "License :: OSI Approved :: Apache Software License",
  "Natural Language :: English",
  "Operating System :: OS Independent",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Topic :: Software Development",
  "Topic :: Software Development :: Libraries",
  "Topic :: Software Development :: Libraries :: Python Modules",
  "Topic :: Utilities",
  "Topic :: Scientific/Engineering",
  "Typing :: Typed",
]
dependencies = [
  "httpx~=0.28",                # Making HTTP requests
  "typing-extensions~=4.15",    # Backported Type Hints for Python 3.8+
  "pydantic~=2.12",             # Data validation and serialization
  "pydantic-settings~=2.11",    # Type-hinted configurations or settings
  "geojson-pydantic~=2.1",      # Data models for the GeoJSON specification
  "mapbox-vector-tile~=2.2",    # Encoding and decoding Mapbox Vector Tiles (MVT)
  "mercantile~=1.2",            # Web mercator XYZ tile utilities
  "pandas~=2.3",                # Data analysis and manipulation
  "geopandas~=1.1",             # Geospatial data analysis and manipulation
]

[project.optional-dependencies]
# Linting and code quality tools
lint = [
  "black[jupyter]>=25.9.0",      # Code formatting tool
  "isort>=7.0.0",                # Python imports sorting tool
  "mypy>=1.18.2",                # Static type checker
  "pydocstyle>=6.3.0",           # Python docstring style checker
  "ruff>=0.14.2",                # Linter and code analysis tool
  "codespell[toml]>=2.4.1",      # Spell checker for code
]

# Testing tools
test = [
  "pytest>=8.4.2",            # Core testing framework
  "pytest-asyncio>=1.2.0",    # Asyncio plugin for pytest
  "pytest-cov>=7.0.0",        # Coverage plugin for pytest
  "pytest-mock>=3.15.1",      # Mocking plugin for pytest
  "pytest-xdist>=3.8.0",      # Parallel test execution for pytest
  "pytest-timeout>=2.4.0",    # Timeout support for pytest
  "coverage[toml]>=7.11.0",   # Code coverage reporting
  "respx>=0.22.0",            # Utility for mocking httpx
]

# Development workflow and tools
dev = [
  "commitizen>=4.9.1",        # Standardized commit messages and versioning
  "pre-commit>=4.3.0",        # Framework for managing pre-commit hooks
  "pip-audit>=2.9.0",         # Audit for finding vulnerabilities in dependencies
]

# Build tools
build = [
  "build>=1.2.2",                 # Python PEP 517 compliant build system
  "check-wheel-contents>=0.6.3",  # Check wheels have the right contents
  "pydistcheck>=0.10.0",          # Inspect Python package distributions for common problems
  "pyroma>=5.0",                  # Test project's packaging friendliness
  "setuptools>=80.9.0",           # Python packaging library
  "twine>=6.2.0",                 # For uploading Python packages to PyPI
]

# Documentation tools
docs = [
  "sphinx>=8.2.3",                  # Tool for generating documentation
  "furo>=2025.9.25",                # Sphinx theme for beautiful documentation
  "myst-parser>=4.0.1",             # Writing documentation with Markdown in Sphinx
  "myst-nb>=1.3.0",                 # Writing documentation with Jupyter Notebook in Sphinx
  "sphinx-copybutton>=0.5.2",       # Add a "copy" button to code blocks in Sphinx
  "sphinx-autobuild>=2025.8.25",    # Build, watch and serve documentation with live reload in the browser
  "sphinx-inline-tabs>=2023.4.21",  # Add inline tabbed content to documentation
  "sphinx-autodoc2>=0.5.0",         # Generates API documentation for Python packages
]

# Jupyter notebook and interactive tools
notebooks = [
  "ipykernel>=7.1.0",         # Jupyter kernel for Python
  "ipython>=9.6.0",           # Enhanced interactive Python shell
  "jupyterlab>=4.4.10",       # Jupyter's next-generation web-based interface
  "watermark>=2.5.0",         # Add timestamps and version info to Jupyter notebook
]


[project.urls]
Homepage = "https://github.com/GlobalFishingWatch/gfw-api-python-client"
Documentation = "https://globalfishingwatch.github.io/gfw-api-python-client/"
Changelog = "https://github.com/GlobalFishingWatch/gfw-api-python-client/blob/main/CHANGELOG.md"
Repository = "https://github.com/GlobalFishingWatch/gfw-api-python-client"
Issues = "https://github.com/GlobalFishingWatch/gfw-api-python-client/issues"

[tool.ruff]
fix = true
line-length = 88
src = ["src", "tests"]
target-version = "py311"

[tool.ruff.format]
docstring-code-format = true

[tool.ruff.lint]
unfixable = []
select = [
    "E",    # pycodestyle errors
    "W",    # pycodestyle warnings
    "F",    # pyflakes
    "RUF",  # Ruff-specific rules
    "ANN",  # flake8-annotations
    "C",    # flake8-comprehensions
    "B",    # flake8-bugbear
    "I",    # isort
    "D",    # pydocstyle
]
ignore = [
  "E501",    # line too long, handled by black
  "C901",    # too complex
  "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed in `**kwargs`
]

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]

[tool.ruff.lint.isort]
lines-after-imports = 2
lines-between-types = 1
known-first-party = ["gfwapiclient", "tests"]

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

[tool.black]
target-version = ["py311"]
line-length = 88

[tool.isort]
profile = "black"
line_length = 88
known_first_party = ["gfwapiclient"]
lines_after_imports = 2
lines_between_sections = 1
lines_between_types = 1
ensure_newline_before_comments = true
force_sort_within_sections = true
src_paths = ["src", "tests"]

[tool.pydocstyle]
convention = "google"

[tool.mypy]
strict = true
ignore_missing_imports = true
files = "src,tests"

[tool.pytest.ini_options]
minversion = "6.0"
testpaths = ["tests"]
asyncio_default_fixture_loop_scope = "function"
asyncio_mode = "auto"

[tool.coverage.run]
source = ["src", "tests"]
branch = true
parallel = true
context = "${CONTEXT}"

[tool.coverage.report]
precision = 2
skip_empty = true
ignore_errors = false
show_missing = true
exclude_lines = [
  # Have to re-enable the standard pragma
  "pragma: no cover",
  # Don't complain about missing debug-only code:s
  "def __repr__",
  "if self.debug",
  # Don't complain if tests don't hit defensive assertion code:
  "raise AssertionError",
  "raise NotImplementedError",
  "AbstractMethodError",
  # Don't complain if non-runnable code isn't run:
  "if 0:",
  "if __name__ == .__main__.:",
  "if TYPE_CHECKING:",
]

[tool.commitizen]
name = "cz_conventional_commits"
version = "1.4.0"
version_files = [
    "pyproject.toml:version",
    "src/gfwapiclient/__version__.py:__version__",
    "docs/source/conf.py:release",
    "CITATION.cff:version",
]
version_provider = "commitizen"
version_scheme = "semver"
major_version_zero = false
tag_format = "v$version"
update_changelog_on_bump = true
changelog_file = "CHANGELOG.md"
bump_message = "chore(release): bump to v$new_version"

[tool.codespell]
skip = ".git,env*,venv*,build*,tmp*"

[tool.pydistcheck]
inspect = false


# Build system metadata.
[tool.setuptools]
include-package-data = true

[tool.setuptools.packages.find]
where = ["src"]
include = ["gfwapiclient", "gfwapiclient.*"]
exclude = ["tests*"]
namespaces = false

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