pyproject.toml

[build-system]
requires = ["uv_build>=0.9.13,<0.10.0"]
build-backend = "uv_build"

[tool.uv.build-backend]
module-name = "incline"
module-root = "."

[project]
name = "incline"
version = "0.5.0"
description = "Estimate Trend at a Particular Point in a Noisy Time Series"
authors = [
    {name = "Suriyan Laohaprapanon", email = "suriyant@gmail.com"},
    {name = "Gaurav Sood", email = "gsood07@gmail.com"}
]
readme = "README.md"
license = { text = "MIT" }
requires-python = ">=3.12"
keywords = ["time-series", "derivative", "slope", "trend", "savitzky-golay", "spline"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Scientific/Engineering :: Information Analysis",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Utilities"
]
dependencies = [
    "pandas>=2.0.0",
    "numpy>=1.25.0",
    "scipy>=1.10.0",
    "statsmodels>=0.14.0",
    "scikit-learn>=1.3.0",
    "matplotlib>=3.7.0"
]

[project.optional-dependencies]
docs = [
    "sphinx>=7.0",
    "furo>=2024.1.29",
    "myst-parser>=3.0",
    "linkify-it-py>=2.0",
    "jupyter-sphinx>=0.5.0",
    "ipykernel>=6.0.0",
    "matplotlib>=3.7.0",
    "sphinx-autoapi>=3.0",
    "sphinx-autodoc-typehints>=2.0"
]

[dependency-groups]
dev = [
    "check-manifest",
    "pytest>=7.0",
    "pytest-cov>=4.0",
    "ruff>=0.7.0",
    "pre-commit>=3.0",
    "jupyter",
    "matplotlib",
    "vulture>=2.16",
]
test = [
    "pytest>=7.0",
    "pytest-cov>=4.0",
    "coverage",
    "ruff>=0.7.0"
]

[project.urls]
Homepage = "https://github.com/finite-sample/incline"
Documentation = "https://finite-sample.github.io/incline/"
Repository = "https://github.com/finite-sample/incline"
Issues = "https://github.com/finite-sample/incline/issues"


[tool.pytest.ini_options]
testpaths = ["tests"]
python_files = ["test_*.py"]
python_classes = ["Test*"]
python_functions = ["test_*"]
addopts = "--cov=incline --cov-report=html --cov-report=term-missing -v"

[tool.coverage.run]
source = ["incline"]
omit = ["*/tests/*"]

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "def __repr__",
    "if self.debug:",
    "if settings.DEBUG",
    "raise AssertionError",
    "raise NotImplementedError",
    "if 0:",
    "if __name__ == .__main__.:"
]

[tool.ruff]
line-length = 88
target-version = "py312"
exclude = [
  ".git",
  "__pycache__",
  "build",
  "dist",
  ".venv",
  "docs",
  ".eggs",
  "*.egg-info",
  "*.ipynb"
]

[tool.ruff.lint]
# Enable comprehensive rule set for style and quality
select = [
  "E",   # pycodestyle errors
  "W",   # pycodestyle warnings
  "F",   # pyflakes
  "I",   # isort
  "B",   # flake8-bugbear
  "C4",  # flake8-comprehensions
  "UP",  # pyupgrade
  "N",   # pep8-naming
  "D",   # pydocstyle (docstrings)
  "S",   # bandit (security)
  "T20", # flake8-print
  "PT",  # flake8-pytest-style
  "RUF", # ruff-specific rules
]

ignore = [
  "E501",  # line too long (handled by formatter)
  "B008",  # do not perform function calls in argument defaults
  "D100",  # missing docstring in public module
  "D101",  # missing docstring in public class
  "D102",  # missing docstring in public method
  "D103",  # missing docstring in public function
  "D104",  # missing docstring in public package
  "D105",  # missing docstring in magic method
  "S101",  # use of assert (allowed in tests)
]

[tool.ruff.lint.per-file-ignores]
# Package init files
"__init__.py" = ["F401", "D104"]

# Test files - more relaxed rules
"tests/*" = [
  "S101",   # assert allowed in tests
  "F841",   # unused variable (test artifacts)
  "D",      # no docstring requirements
  "T20",    # print statements allowed
  "N",      # naming conventions relaxed
]

# Example files - demo clarity over strict style
"examples/*" = [
  "E402",   # imports not at top
  "F841",   # unused variables for illustration
  "E722",   # bare except for simple examples
  "T20",    # print statements for output
  "D",      # no docstring requirements
]

# Documentation files
"docs/*" = [
  "D",      # no docstring requirements
  "T20",    # print statements allowed
]

[tool.ruff.lint.isort]
known-first-party = ["incline"]
force-single-line = false
lines-after-imports = 2

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"

[tool.deptry]
# Treat the "docs" optional dependency group as dev dependencies
pep621_dev_dependency_groups = ["docs"]
# Extend default excludes to include docs directory
extend_exclude = ["docs"]

[tool.pydoclint]
paths = ["incline"]
style = "google"
exclude = [".git", "__pycache__", "build", "dist", ".venv", "docs", ".eggs", "*.egg-info", "*.ipynb"]
require-return-section-when-returning-nothing = false
require-yield-section-when-yielding-nothing = false
arg-type-hints-in-signature = true
arg-type-hints-in-docstring = false
check-return-types = false

[tool.pyright]
include = ["incline", "tests"]
exclude = [
  "**/__pycache__",
  ".venv",
  "docs",
  "build",
  "dist",
  "*.egg-info"
]
reportMissingImports = true
reportMissingTypeStubs = false
pythonVersion = "3.12"
venvPath = "."
venv = ".venv"