pyproject.toml

[project]
name = "opensampl"
version = "1.2.6"
description = "Python tools for adding clock data to a timescale db."
license = {file = "LICENSE"}
authors = [
    { name = "Midgie MacFarland", email = "macfarlandmj@ornl.gov" },
    { name = "Cory Watson", email = "watsoncl1@ornl.gov" },
    { name = "Joshua Grant", email = "grantjn@ornl.gov" },
]
readme = "README.md"
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Telecommunications Industry",
    "Intended Audience :: System Administrators",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Natural Language :: English",
    "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",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: System :: Monitoring",
    "Topic :: Database",
    "Topic :: Database :: Database Engines/Servers",
    "Topic :: Communications",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Scientific/Engineering :: Visualization",
    "Topic :: System :: Networking :: Monitoring",
    "Environment :: Console",
    "Environment :: Web Environment",
    "Framework :: Pydantic",
    "Framework :: Pydantic :: 2"
]
requires-python = ">=3.11,<3.15"
dependencies = [
    "pydantic>=2.10.3,<3",
    "pydantic-settings>=2.9.0",
    "sqlalchemy>=2.0.55,<3",
    "geoalchemy2>=0.18.0,<1",
    "click>=8.0.0,<9",
    "pandas>=2.2.1,<3",
    "tqdm>=4.66.2,<5",
    "numpy>=1.26.4,<2; python_version < '3.13'",
    # NumPy 2.4 supports both Python 3.13 and 3.14 with published wheels.
    "numpy>=2.4.0,<3; python_version >= '3.13'",
    "pytz>=2024.1,<2027.0",
    "requests>=2.32.4,<3",
    # requests permits a broad urllib3 range; keep published installs above the
    # fixes for GHSA-8988-9cw3-xx77, GHSA-vxq7-64xx-v4gw, and GHSA-gh4c-6fx4-qh6g.
    "urllib3>=2.8.0,<3",
    "pyyaml>=6.0.0,<7",
    "allantools",
    "loguru>=0.7.0,<0.8",
    "psycopg2-binary>=2.9.0,<3",
    "python-dotenv>=1.1.1,<2",
    "python-multipart>=0.0.27,<0.1",
    "astor",
    # 1.9 publishes native wheels for Python 3.14 and understands its grammar.
    "libcst>=1.9.0,<2",
    "jinja2>=3.1.6",
    "tabulate",
    "pydanclick",
]

[project.urls]
Homepage = "https://github.com/ORNL/OpenSAMPL"
Repository = "https://github.com/ORNL/OpenSAMPL"
Documentation = "https://ornl.github.io/OpenSAMPL"
Changelog = "https://github.com/ORNL/OpenSAMPL/blob/main/CHANGELOG.md"

[project.optional-dependencies]
migrations = [
    "alembic",
    # Alembic renders migration templates with Mako.
    "mako>=1.4.2,<2",
]
backend = [
    "fastapi>=0.146.0,<1",
    "uvicorn",
    "prometheus-client",
    # FastAPI/Starlette permit older AnyIO releases that contain TLS and
    # process-pool vulnerabilities.
    "anyio>=4.14.2,<5",
]
collect = [
    "telnetlib3>=5.0.1",
    "ntplib>=0.4.0,<0.5"
]

[project.scripts]
opensampl = "opensampl.cli:cli"
opensampl-server = "opensampl.server.cli:cli"
opensampl-server2 = "opensampl.server.cli2:cli"
opensampl-collect = "opensampl.collect.cli:cli"

[dependency-groups]
dev = [
    "ty",
    "pytest>=8.4.0",
    "pytest-cov",
    "pytest-mock>=3.17.0,<4",
    "ruff",
    "mkdocs",
    # 1.0.6+ supports the PyMdown Extensions 12 Highlight API.
    "mkdocstrings[python]>=1.0.6,<2",
    "mkdocs-gen-files",
    "mkdocs-material>=9.7.7,<10",
    "pymdown-extensions>=11.0.1,<13",
    "mkdocs-click",
    "psycopg[binary]",
    "pytest-postgresql"
]

[tool.hatch.build.targets.sdist]
include = [
    "opensampl/server/docker-compose.yaml",
    "opensampl/server/docker-compose.dev.yaml",
    "opensampl/server/default.env",
    "opensampl/server/migrations/*",
    "opensampl/server/grafana/*",
    "opensampl/server/backend/*",
    "opensampl/create/templates/*",
    "opensampl/**/*.py",
]
exclude = [".env"]

[tool.hatch.build.targets.wheel]
include = [
    "opensampl/server/docker-compose.yaml",
    "opensampl/server/docker-compose.dev.yaml",
    "opensampl/server/default.env",
    "opensampl/server/migrations/*",
    "opensampl/server/grafana/*",
    "opensampl/server/backend/*",
    "opensampl/create/templates/*",
    "opensampl/**/*.py",
]
exclude = [".env"]

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

[tool.ruff]
line-length = 120
exclude = [".git", "__pycache__", "venv", "env", ".venv", ".env", "build", "dist", "docs", "opensampl/server/migrations/**/*.py"]
include = ["opensampl/**/*.py"]

[tool.ruff.lint]
select = ["F", "E", "W", "C", "I", "D", "N", "B", "ERA", "ANN", "S", "A", "COM", "C4",
          "DTZ", "T10", "EM", "FA", "INT", "ICN", "LOG", "G", "PIE", "INP", "T20",
          "PYI", "PT", "Q", "RSE", "RET", "SLF", "SIM", "TID", "TC", "ARG", "PTH",
          "FLY", "PERF", "PL", "UP", "FURB", "RUF", "TRY"]
ignore = ["D203", "D212", "D400", "D415", "ANN401", "S101", "PLR2004", "COM812",
          "ANN201", "B011", "EM102", "TRY003", "ANN204", "FA100", "PIE790", "EM101",
            "PLC0415", 'E741']

[tool.ruff.lint.per-file-ignores]
"opensampl/vendors/**/*.py" = ['S311'] # we want to ignore the errors about random
"opensampl/server/backend/main.py" = ['B008', 'ARG001'] #ignore complaints about calling functions in args
"opensampl/mixins/random_data.py" = ['S311']

[tool.ruff.lint.pylint]
max-args = 10

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
docstring-code-format = true