pyproject.toml

[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "hpcperfstats"
version = "3.0"
description = "A performance monitoring and analysis package for High Performance Computing Platforms"
readme = "README.md"
requires-python = ">=3.12"
license = { file = "LICENSE" }
authors = [
  { name = "Texas Advanced Computing Center", email = "sharrell@tacc.utexas.edu" },
]
urls = { homepage = "http://www.tacc.utexas.edu", repository = "https://github.com/TACC/hpcperfstats" }

classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Environment :: Console",
  "Operating System :: POSIX :: Linux",
  "Intended Audience :: Science/Research",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.12",
  "Topic :: Scientific/Engineering",
]
dependencies = [
  "numpy==2.5.1",
  "numexpr",
  "psycopg==3.3.4",
  "pandas==3.0.5",
  "bokeh==3.9.2",
  "Django>=6.0.7,<6.1",
  "python-hostlist",
  "pika==1.4.2",
  "mysqlclient",
  "gunicorn",
  "requests>=2.34.2",
  "cryptography>=50.0.0",
  "pillow>=12.3.0",
  "tzdata",
  "redis==8.1.0",
  "djangorestframework",
  "drf-spectacular>=0.30.0",
  "django-cors-headers",
  "setproctitle",
]

[project.optional-dependencies]
test = [
  "pytest>=9.1.1",
  "pytest-django>=4.12.0",
  "pytest-cov>=7.1.0",
  "playwright>=1.62.0",
  "psycopg[binary]",
]
dev = [
  "ruff>=0.16.1",
  "pylint>=4.0.6",  # optional; Ruff is the primary linter (see docs/TESTING.md)
  "vulture>=2.16",
  "pre-commit>=4.6.1",
]

[tool.pytest.ini_options]
testpaths = ["hpcperfstats"]
python_files = ["test_*.py", "*_test.py"]
python_functions = ["test_*"]
addopts = "-v --tb=short"
pythonpath = ["."]
DJANGO_SETTINGS_MODULE = "hpcperfstats.site.hpcperfstats_site.settings"
django_find_project = false
filterwarnings = ["ignore::DeprecationWarning", "ignore::UserWarning"]
markers = [
  "django: marks tests requiring Django (dbs, settings).",
  "machine_unit_mock: site.lib.machine.tests mocks only; no DB (see hpcperfstats/conftest.py).",
  "live_redis: live Redis cache integration; requires HPCPERFSTATS_PYTEST_LIVE_REDIS=1 and compose redis.",
    "stress_host_data: optional Timescale stress in tests/stress_host_data; requires HPCPERFSTATS_STRESS_HOST_DATA=1.",
    "pipeline_e2e: optional full-stack pipeline tests in tests/pipeline_e2e; requires HPCPERFSTATS_PIPELINE_E2E=1 and compose.",
]

[tool.setuptools]
script-files = [
  "hpcperfstats/analysis/metrics/update_metrics.py",
  "hpcperfstats/site/manage.py",
  "hpcperfstats/dbload/sync_acct.py",
  "hpcperfstats/dbload/sync_timedb.py",
  "hpcperfstats/dbload/sync_timedb_archive.py",
  "hpcperfstats/listend.py",
  "hpcperfstats/listend_drain.py",
  "scripts/apply_compose_cpu_pinning.py",
  "scripts/invalidate_archive_members.py",
]

[tool.setuptools.packages.find]
include = ["hpcperfstats*"]

[tool.setuptools.package-data]
hpcperfstats = [
  "tests/fixtures/axe-core/axe.min.js",
  "tests/fixtures/axe-core/README.md",
]
"hpcperfstats.dbload.lib.monitor_naming" = [
  "monitor_variable_rename_map.yaml",
]
"hpcperfstats.site.hpcperfstats_site" = [
  "static/**/*",
]

[tool.ruff]
target-version = "py312"
line-length = 80  # Google style guide
extend-exclude = [
  "migrations",
  ".venv",
  "env",
  ".git",
  "__pycache__",
  ".ruff*",
  ".tools",
  "build",
  "dist",
]

[tool.ruff.lint]
select = [
  "E",  # pycodestyle errors
  "F",  # pyflakes
  "I",  # import sorting
  "B",  # flake8-bugbear
  "W",  # pycodestyle warnings
]
ignore = [
  # Add specific rule codes here if Ruff is too strict somewhere.
]
fixable = ["ALL"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
line-ending = "auto"
docstring-code-format = true

[tool.hpcperfstats.testing]
web_e2e_runner = "tests/run_web_e2e_workflow.sh"
db_pytest_runner = "tests/run_db_pytest_workflow.sh"
redis_cache_pytest_runner = "tests/run_redis_cache_pytest_workflow.sh"

[tool.coverage.run]
branch = true
source = ["hpcperfstats"]
omit = [
  "*/migrations/*",
  "*/tests/*",
  "*/test_*.py",
  "*/conftest.py",
]

[tool.coverage.report]
skip_empty = true
show_missing = true
precision = 1
exclude_lines = [
  "pragma: no cover",
  "def __repr__",
  "raise NotImplementedError",
  "if TYPE_CHECKING:",
  "@abstractmethod",
]

[tool.coverage.html]
directory = "htmlcov"

[tool.vulture]
paths = ["hpcperfstats"]
min_confidence = 80
ignore_decorators = [
  "@receiver",
  "@pytest.fixture",
  "@api_view",
  "@authentication_classes",
  "@contextmanager",
]
ignore_names = [
  "urlpatterns",
  "ready",
  "Meta",
  "handle",
  "add_arguments",
]