pyproject.toml

[project]
name = "dial"
version = "0.1.0"
authors = [{ name = "Stephen DeWitt", email = "dewittsj@ornl.gov"}, { name = "Lance Drane", email = "dranelt@ornl.gov" }, { name = "David Joy", email = "davidjoy022@gmail.com" }, { name = "Jacob Sweet", email = "jsweet@gatech.edu" }]
description = "Dial (Distributed INTERSECT Active Learning): An INTERSECT service that provides Bayesian optimization and active learning"
readme = "README.md"
requires-python = ">=3.10"
keywords = ["active learning"]
license = {text = "BSD-3-Clause"}
classifiers = ["Programming Language :: Python :: 3"]
# TODO move some dependencies into optional dependencies
dependencies = [
    "intersect_sdk[amqp]>=0.8.3,<0.9.0",
    "matplotlib>=3.8.2,<4.0.0",          # TODO - this is only required if using gpax or running the client, consider making an optional dependency group
    "numpy>=1.26.3,<2.0.0",
    "scikit-learn>=1.4.0,<2.0.0",        # TODO consider making an optional dependency group
    "scipy>=1.12.0,<2.0.0",
    "gpax>=0.1.8",                       # TODO consider making an optional dependency group
    "pymongo>=4.12.1",                   # TODO - this is only needed for dial_service, dial_dataclass can use a simple fixture for ObjectID representation which allows it to skip this dependency
]

[tool.pdm.dev-dependencies]
lint = [
    "pre-commit>=3.3.1",
    "mypy>=1.10.0",
    "ruff==0.9.4",
]
test = ["pytest>=7.3.2", "pytest-cov>=4.1.0", "httpretty>=1.1.4"]

[tool.pdm.scripts]
# add --cov-fail-under=<NUMBER> when ready to require a minimum coverage amount
test-all = "pytest tests/ --cov=src/ --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml"
test-unit = "pytest tests/unit/"

[tool.ruff]
line-length = 100
format = { quote-style = 'single' }
namespace-packages = ["scripts/", "tests/"]

[tool.ruff.lint]
isort = { known-first-party = ['src'] }
pydocstyle = { convention = 'google' }
flake8-quotes = { inline-quotes = 'single', multiline-quotes = 'double' }
mccabe = { max-complexity = 20 }
pylint = { max-args = 10, max-branches = 20, max-returns = 10, max-statements = 75 }
# pyflakes and the relevant pycodestyle rules are already configured
extend-select = [
    'C90', # mccabe complexity
    'I',   # isort
    'N',   # pep8-naming
    #'D',     # pydocstyle           - disabled for now
    'UP',  # pyupgrade
    'YTT', # flake8-2020
    #'ANN',   # flake8-annotations   - disabled for now
    'ASYNC', # flake8-async
    'S',     # flake8-bandit
    'BLE',   # flake8-blind-except
    'B',     # flake8-bugbear
    'A',     # flake8-builtins
    'COM',   # flake8-commas
    'C4',    # flake8-comprehensions
    'DTZ',   # flake8-datetimez
    'T10',   # flake8-debugger
    'EM',    # flake8-error-message
    'FA',    # flake8-future-annotations
    'ISC',   # flake8-implicit-string-concat
    'ICN',   # flake8-import-conventions
    'G',     # flake8-logging-format
    'INP',   # flake8-no-pep420
    'PIE',   # flake8-PIE
    'T20',   # flake8-T20
    'PYI',   # flake8-pyi
    'PT',    # flake8-pytest-style
    'Q',     # flake8-quotes
    'RSE',   # flake8-raise
    'RET',   # flake8-return
    'SLF',   # flake8-self
    'SLOT',  # flake8-slots
    'SIM',   # flake8-simplify
    'TCH',   # flake8-type-checking
    'ARG',   # flake8-unused-arguments
    'PTH',   # flake8-use-pathlib
    'PGH',   # pygrep-hooks
    'PL',    # pylint
    'TRY',   # tryceratops
    'FLY',   # flynt
    'RUF',   # RUFF additional rules
]
# If you're seeking to disable a rule, first consider whether the rule is overbearing, or if it should only be turned off for your usecase.
ignore = [
    'COM812',  # formatter, handled by Ruff format
    'ISC001',  # formatter, handled by Ruff format
    'SIM105',  # "with contextlib.suppress():" is slower than try-except-pass
    'ANN401',  # allow explicit "Any" typing, use with care
    'PLR2004', # allow "magic numbers"
    # TODO - should not ignore below in long term, but will for now
    'N802',    # do not require snake_casing function names
    'N803',    # do not require snake_casing function/method arguments
    'N806',    # allow uppercase in function names
    'N812',    # allow lowercase imports to be aliased to non-lowercase names
]

[tool.ruff.lint.extend-per-file-ignores]
'__init__.py' = ['F401'] # __init__.py commonly has unused imports
'docs/*' = [
    'D',      # the documentation folder does not need documentation
    'INP001', # docs are not a namespace package
]
'scripts/*' = [
    'T20', # allow print/pprint statements in scripts
    'N999', # allow scripts to have non-pep8-compliant names, i.e. "2d_rosenbrock"
]
'tests/*' = [
    'S101',   # allow assert statements in tests
    'S106',   # don't care about credentials in tests
    'S311',   # don't care about cryptographic security in tests
    'SLF001', # allow private member access in tests
    'ANN',    # tests in general don't need types, unless they are runtime types.
    'ARG',    # allow unused parameters in tests
    'D',      # ignore documentation in tests
    'FA100',  # tests frequently use runtime typing annotations
]

[tool.mypy]
#strict = true
ignore_missing_imports = true       # don't require typing for library stubs if they don't exist
disallow_untyped_decorators = false # this is needed for library decorator compatibility, i.e. "retrying"
plugins = ["pydantic.mypy"]

[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[dependency-groups]
dev = [
    "statsmodels>=0.14.4",
]