pyproject.toml

[project]
name = "dplib-py"
dynamic = ["version"]
description = "Python implementation of the Data Package standard"
license = "MIT"
readme = "README.md"
requires-python = ">=3.8"
urls.homepage = "https://github.com/frictionlessdata/dplib-py"
authors = [
    {name = "Open Knowledge Foundation", email = "info@okfn.org"},
]
keywords=[
    "data validation",
    "open data",
    "json schema",
    "json table schema",
    "data package",
    "tabular data package",
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Environment :: Console",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Topic :: Software Development :: Libraries :: Python Modules",
]
dependencies = [
    "pyyaml>=5.0",
    "pydantic>=2.0",
    "jsonschema>=3.0",
    "python-slugify>=6.0",
    "fsspec[http]>=2023.1.0",
    "typing-extensions>=4.0",
]

[project.optional-dependencies]
cli = ["typer>=0.12", "rich>=10.0"]
dcat = ["rdflib>=6.0"]
pandas = ["pandas>=1.0", "pandas-stubs>=1.0", "numpy>=1.0", "isodate>=0.6"]
polars = ["polars-lts-cpu>=0.10"]
sql = ["sqlalchemy>=1.4"]
dev = [
    "ruff",
    "hatch",
    "neovim",
    "pyright",
    "ipython",
    # mkdocs
    "mkdocs",
    "mkdocstrings[python]",
    "mkdocs-material",
    # pytest
    "pytest",
    "pytest-cov",
    "pytest-vcr",
    "pytest-mock",
    "pytest-dotenv",
    "pytest-timeout",
    "pytest-lazy-fixtures",
]

[project.scripts]
dp = "dplib.plugins.cli.__main__:program"

[tool.hatch.version]
path = "dplib/settings.py"

[tool.hatch.build.targets.wheel]
packages = ["dplib"]

[tool.hatch.envs.default]
python = "3.10"
dependencies = [
  "dplib-py[cli,dcat,sql,pandas,polars,dev]",
]

[tool.hatch.envs.default.scripts]
coverage = [
  "sensible-browser coverage/index.html",
]
docs = [
  "mkdocs serve",
]
docs-build = [
  "mkdocs build",
]
format = [
  "ruff check --fix",
  "ruff format dplib",
]
lint = [
  "ruff check dplib",
]
release = [
  """
  VERSION=$(hatch run version)
  git checkout main && git pull origin && git fetch -p
  git log --pretty=format:"%C(yellow)%h%Creset %s%Cgreen%d" --reverse -20
  echo "\nReleasing v$VERSION in 10 seconds. Press <CTRL+C> to abort\n" && sleep 10
  hatch run test && git commit -a -m "v$VERSION" && git tag -a "v$VERSION" -m "v$VERSION"
  git push --follow-tags
  """
]
spec = [
  "pytest --cov dplib --cov-report term-missing --cov-report html:coverage --cov-fail-under 0 --timeout=300",
]
test = [
  "lint",
  "type",
  "spec",
]
type = [
  "pyright dplib",
]
version = [
  "hatch --no-color version"
]

[[tool.hatch.envs.ci.matrix]]
python = ["3.8", "3.9", "3.10", "3.11", "3.12"]

[tool.hatch.envs.ci.scripts]
spec = [
  "pytest --cov dplib --cov-report term-missing --cov-report xml --cov-fail-under 0 --timeout=300 --ci",
]
test = [
  "lint",
  "type",
  "spec",
]

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.ruff]
line-length = 90

[tool.ruff.lint]
ignore = ["E501", "E731", "F405"]
extend-select = ["I"]

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

[tool.pytest.ini_options]
testpaths = ["dplib"]
env_files = [".env"]
markers = [
    "ci: integrational tests (select with '--ci')",
]

[tool.pyright]
strict = ["dplib"]
include = ["dplib"]
ignore = ["**/__init__.py"]