pyproject.toml

[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "tiled"
description = "Structured Scientific Data Access Service"
readme = { file = "README.md", content-type = "text/markdown" }
authors = [
  { name = "Bluesky Project Contributors", email = "dallan@bnl.gov" },
]
maintainers = [
  { name = "Brookhaven National Laboratory", email = "dallan@bnl.gov" },
]
requires-python = ">=3.9"

# Dependencies common to both server and client; additional dependencies are
# available depending on whether you are running client/server/both, and what
# data structures you care about.
# Use pip install tiled[all] to get everything.
dependencies = [
    "httpx >=0.20.0,!=0.23.1",
    "json-merge-patch",
    "jsonpatch",
    "jsonschema",
    "msgpack >=1.0.0",
    "orjson",
    "platformdirs",
    "pydantic >=2, <3",
    "pydantic-settings >=2, <3",
    "pyyaml",
    "typer",
]

classifiers = [
  "Development Status :: 4 - Beta",
  "License :: OSI Approved :: BSD License",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Topic :: Scientific/Engineering :: Physics",
]

dynamic = ["version"]

[project.scripts]
tiled = "tiled.commandline.main:main"

[project.optional-dependencies]
# When updating the dependencies, make sure to coordinate changes with the list
# 'all', 'server' and 'client', which aggregate dependencies from other more
# finely-targeted lists.

# This is the union of all optional dependencies.
all = [
    "adbc_driver_manager",
    "adbc_driver_postgresql",
    "adbc_driver_sqlite",
    "aiofiles",
    "aiosqlite",
    "alembic",
    "anyio",
    "asgi-correlation-id",
    "asyncpg",
    "awkward >=2.4.3",
    "blosc2; python_version >= '3.10'",
    "cachetools",
    "canonicaljson",
    "dask",
    "dask[array]",
    "dask[dataframe]",
    "duckdb <1.4.0",  # https://github.com/bluesky/tiled/issues/1144
    "entrypoints",
    "fastapi >=0.115.8",
    "h5netcdf",
    "h5py",
    "hdf5plugin",
    "jinja2",
    "jmespath",
    "lz4",
    "ndindex",
    "numcodecs",
    "numpy",
    "numba >=0.59.0",  # indirect, pinned to assist uv solve
    "openpyxl",
    "packaging",
    "pandas",
    "pillow",
    "prometheus_client",
    "pyarrow >=14.0.1",  # includes fix to CVE 2023-47248
    "python-dateutil",
    "python-jose[cryptography]",
    "python-multipart",
    "redis",
    "rich",
    "sparse >=0.15.5",
    "sqlalchemy[asyncio] >=2",
    "stamina",
    "starlette >=0.38.0",
    "tifffile",
    "uvicorn[standard]",
    "watchfiles",
    "xarray",
    "zarr",
    "zstandard",
]
# These are needed by the client and server to transmit/receive arrays.
array = [
    "dask[array]",
    "numpy",
]
# This is the "kichen sink" fully-featured client dependency set.
client = [
    "awkward >=2.4.3",
    "blosc2; python_version >= '3.10'",
    "dask[array]",
    "dask[dataframe]",
    "entrypoints",
    "lz4",
    "ndindex",
    "numba >=0.59.0",  # indirect, pinned to assist uv solve
    "numpy",
    "pandas",
    "pyarrow >=14.0.1",  # includes fix to CVE 2023-47248
    "rich",
    "sparse >=0.15.5",
    "stamina",
    "websockets",
    "watchfiles",
    "xarray",
    "zstandard",
]
# These are used by the client/server to more efficiently compress.
# They fall back to gzip (which is slower) if these are not installed.
compression = [
    "blosc2; python_version >= '3.10'",
    "lz4",
    "zstandard",
]
# These are needed by the client and server to transmit/receive dataframes.
dataframe = [
    "dask[dataframe]",
    "pandas",
    "pyarrow >=14.0.1",  # includes fix to CVE 2023-47248
]
# These are required for developing the package (running the tests, building
# the documentation) but not necessarily required for _using_ it.
dev = [
    "aiohttp",
    "coverage",
    "flake8",
    "importlib_resources;python_version < \"3.9\"",
    "ipython",
    "ldap3",
    "locust",
    "matplotlib",
    "mistune",
    "myst-parser",
    "numpydoc",
    "pre-commit",
    "pytest",
    "pytest-asyncio",
    "pytest-mock",
    "pytest-rerunfailures",
    "sphinx !=4.1.0, !=4.1.1, !=4.1.2, !=4.2.0",
    "sphinx-click",
    "sphinx-copybutton",
    "sphinx_rtd_theme",
    "sphinxcontrib-mermaid",
    "types-cachetools",
]
# These are used by the server to read files in the respective formats.
formats = [
    "h5netcdf",
    "h5py",
    "hdf5plugin",
    "openpyxl",
    "pillow",
    "tifffile",
]
# These are the requirements needed for basic client functionality.
minimal-client = [
    "entrypoints",
    "rich",
    "stamina",
    "watchfiles",
    "websockets",
]
# These are the requirements needed for basic server functionality.
minimal-server = [
    "aiofiles",
    "aiosqlite",
    "alembic",
    "anyio",
    "asgi-correlation-id",
    "cachetools",
    "canonicaljson",
    "dask",
    "fastapi >=0.115.8",
    "jinja2",
    "jmespath",
    "numcodecs",
    "packaging",
    "prometheus_client",
    "python-dateutil",
    "python-jose[cryptography]",
    "python-multipart",
    "redis",
    "sqlalchemy[asyncio] >=2",
    "starlette >=0.38.0",
    "uvicorn[standard]",
    "zarr",
]
# This is the "kichen sink" fully-featured server dependency set.
server = [
    "adbc_driver_manager",
    "adbc_driver_postgresql",
    "adbc_driver_sqlite",
    "aiofiles",
    "aiosqlite",
    "alembic",
    "anyio",
    "asgi-correlation-id",
    "asyncpg",
    "awkward >=2.4.3",
    "blosc2; python_version >= '3.10'",
    "cachetools",
    "canonicaljson",
    "dask",
    "dask[array]",
    "dask[dataframe]",
    "duckdb <1.4.0",  # https://github.com/bluesky/tiled/issues/1144
    "entrypoints",
    "fastapi >=0.115.8",
    "h5netcdf",
    "h5py",
    "hdf5plugin",
    "jinja2",
    "jmespath",
    "lz4",
    "ndindex",
    "numba >=0.59.0",  # indirect, pinned to assist uv solve
    "numcodecs",
    "numpy",
    "openpyxl",
    "packaging",
    "pandas",
    "pillow",
    "prometheus_client",
    "pyarrow >=14.0.1",  # includes fix to CVE 2023-47248
    "python-dateutil",
    "python-jose[cryptography]",
    "python-multipart",
    "sparse >=0.15.5",
    "stamina",
    "redis",
    "sqlalchemy[asyncio] >=2",
    "starlette >=0.38.0",
    "tifffile",
    "uvicorn[standard]",
    "websockets",
    "xarray",
    "zarr",
    "zstandard",
]
# These are needed by the client and server to transmit/receive sparse arrays.
sparse = [
    "ndindex",
    "numba >=0.59.0",  # indirect, pinned to assist uv solve
    "pyarrow >=14.0.1",  # includes fix to CVE 2023-47248
    "sparse >=0.15.5",
]
# These are needed by the client and server to transmit/receive xarrays.
xarray = [
    "dask[array]",
    "pandas",
    "pyarrow",
    "xarray",
]

[project.urls]
Homepage = "https://github.com/bluesky/tiled"
Documentation = "https://blueskyproject.io/tiled"
"Bug Tracker" = "https://github.com/bluesky/tiled/issues"

[tool.hatch]
version.source = "vcs"
version.fallback-version = "0.0.0"

[tool.hatch.build.hooks.vcs]
version-file = "tiled/_version.py"

# Defining this (empty) section invokes hatch_build.py
[tool.hatch.build.hooks.custom]

[tool.hatch.build.targets.wheel.shared-data]
"share/tiled/.identifying_file_72628d5f953b4229b58c9f1f8f6a9a09" = "share/tiled/.identifying_file_72628d5f953b4229b58c9f1f8f6a9a09"
"share/tiled/static" = "share/tiled/static"
"share/tiled/templates" = "share/tiled/templates"
"share/tiled/ui" = "share/tiled/ui"

[tool.black]
line-length = 88
target-version = ['py37']
include = '\.pyi?$'
exclude = '''

(
  /(
    | \.git
    | \.mypy_cache
    | \.venv
    | _build
    | build
    | dist
  )/
  | versioneer.py
  | tiled/_version.py
  | tiled/serialization/_zipfile_py39.py
  | docs/source/conf.py
  | share
  | web-frontend
)
'''

[tool.coverage.run]
data_file = "/tmp/tiled.coverage"

[tool.coverage.report]
exclude_lines = ["if __name__ == '__main__':"]

[tool.coverage.paths]
source = ["."]