pyproject.toml

[project]
name = "Signal-System"
version = "0.0.1"
description = "A package for signal and system simulation, design, analysis, and learning."
readme = "README.md"
requires-python = ">=3.13"
license = "MIT"
authors = [
    {name = "Heng-Sheng Chang", email="hanson.hschang+signal.system@gmail.com"}
]
keywords = ["Signal", "System", "Learning"]

# Pypi classifiers: https://pypi.org/classifiers/
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Education",
    "Operating System :: OS Independent",
    "License :: OSI Approved :: MIT License",
    "Natural Language :: English",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.13",
]

dependencies = [
    "numpy>=1.26.0",
    "scipy>=1.11.0",
    "numba>=0.60.0",
    "torch>=2.6.0",
    "matplotlib>=3.7.2",
    "h5py>=3.0.0",
    "tqdm>=4.60.0",
    "click>=8.1.7",
    "psutil>=6.1.1",
]

[project.urls]
# Homepage = "https://example.com"
# Documentation = "https://readthedocs.org"
Repository = "https://github.com/hanson-hschang/Signal-System"
Issues = "https://github.com/hanson-hschang/Signal-System/issues"

[dependency-groups]
dev = [
    "pyupgrade>=3.15.2",
    "pre-commit>=3.7.1",
    "pytest>=8.2.1",
    "pytest-mock>=3.14.0",
    "pytest-cov>=5.0.0",
    "pytest-dependency>=0.6.0",
    "codecov>=2.1.13",
    "ruff",
    "mypy>=1.10.0",
    "mypy-extensions>=1.0.0",
    "bandit[toml]>=1.7.0",
]

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

[tool.hatch.build.targets.wheel]
# Tell Hatch where to find your package source code.
packages = ["src/ss"]

[tool.hatch.build.targets.sdist]
# Ensure the source directory is included in the source distribution.
include = ["/src"]

[tool.pytest.ini_options]
norecursedirs = [
    "hooks",
    "*.egg",
    ".eggs",
    "dist",
    "build",
    "docs",
    ".tox",
    ".git",
    "__pycache__",
]
doctest_optionflags = [
    "NUMBER",
    "NORMALIZE_WHITESPACE",
    "IGNORE_EXCEPTION_DETAIL",
    "ELLIPSIS",
]
addopts = [
    "--strict-markers",
    "--tb=short",
]

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover", # Enable pragma
    "TODO",
    # Don't complain if non-runnable code isn't run:
    "if 0:",
    "if __name__ == __main__:",
    "def __repr__",
    "def plot_.*\\b",
    "if self.debug:",
    "if settings.DEBUG",
    "if TYPE_CHECKING:",
    "raise AssertionError",
    "raise NotImplementedError",
    "class .*\\bProtocol\\):",
    "@(abc\\.)?abstractmethod",
    "\\.\\.\\."
]
fail_under = 30
show_missing = true

[tool.coverage.run]
branch = true
omit = [
    "*/.local/*",
    "setup.py",
]

[tool.ruff]
# Set the line length for both the linter and formatter.
line-length = 79

# Set the target Python version.
target-version = "py313"

# Define files and directories to be excluded from checks.
# Ruff uses glob patterns and merges the lists.
exclude = [
    ".git",
    ".hg",
    ".mypy_cache",
    ".tox",
    ".venv",
    "__pycache__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "env",
    "venv",
]

[tool.ruff.lint]
# Select the rule sets to enable.
# "E" (pycodestyle errors), "W" (pycodestyle warnings), and "F" (Pyflakes)
# are a good starting point to replicate flake8's default behavior.
select = ["E", "F", "W"]

[tool.mypy]
# https://mypy.readthedocs.io/en/latest/config_file.html#using-a-pyproject-toml-file
python_version = "3.13"
pretty = true
show_traceback = true
color_output = true
strict = true
allow_redefinition = false
check_untyped_defs = false
disallow_subclassing_any = false
disallow_untyped_calls = false
disallow_any_generics = false
disallow_incomplete_defs = true
ignore_missing_imports = true
implicit_reexport = true
no_implicit_optional = true
show_column_numbers = true
show_error_codes = true
show_error_context = true
strict_equality = true
strict_optional = true
warn_no_return = true
warn_redundant_casts = true
warn_return_any = true
warn_unreachable = false
warn_unused_configs = true
warn_unused_ignores = true
exclude = [
    'src/draft/.*\.py$',
]