pyproject.toml

[build-system]
requires = ["setuptools>=67.6.1"]
build-backend = "setuptools.build_meta"

[project]
name = "Annealing"
authors = [{ name = "Jason C Del Rio", email = "spillthetea917@gmail.com" }]
maintainers = [{ name = "Jason C Del Rio", email = "spillthetea917@gmail.com" }]
description = "Clean Extensible Interface for Simulated Annealing."
license = { file = "LICENSE" }
requires-python = ">=3.10"
keywords = [
  "simulated annealing",
  "optimization",
  "TSP",
  "combinatorics",
  "traveling salesman problem",
]
classifiers = [
  "Development Status :: 3 - Alpha",
  "Programming Language :: Python :: 3",
  "License :: OSI Approved :: MIT License",
  "Intended Audience :: Science/Research",
  "Topic :: Scientific/Engineering :: Information Analysis",
]
dynamic = ["version", "readme", "dependencies"]

[project.urls]
homepage = "https://github.com/Spill-Tea/Simulated-Annealing"
issues = "https://github.com/Spill-Tea/Simulated-Annealing/issues"

[tool.setuptools.dynamic]
version = { attr = "Annealing.__version__" }
readme = { file = ["README.md"], content-type = "text/markdown" }
dependencies = { file = ["requirements.txt"] }

[tool.setuptools]
package-dir = { "" = "src" }

[tool.setuptools.packages.find]
where = ["src"]
exclude = ["benchmarks", "docs", "tests"]

[tool.setuptools.package-data]
"*" = ["py.typed", "*.pyi"]

[project.optional-dependencies]
dev = ["Annealing[doc,test,lint,type]", "tox", "pre-commit"]
doc = ["sphinx", "furo", "sphinx_multiversion"]
test = ["pytest", "coverage", "pytest-xdist"]
lint = ["pylint", "ruff"]
type = ["mypy"]

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-n auto -rA"

[tool.coverage.run]
parallel = true
branch = true
source = ["Annealing"]
disable_warnings = ["no-data-collected", "module-not-imported"]

[tool.coverage.paths]
source = ["src", "*/.tox/py*/**/site-packages"]

[tool.coverage.report]
fail_under = 95.0
precision = 1
show_missing = true
skip_empty = true
exclude_also = [
  "def __repr__",
  'if __name__ == "__main__"',
  "raise NotImplementedError"
]

[tool.mypy]
mypy_path = "Annealing"
warn_unused_ignores = true
allow_redefinition = false

[tool.pylint.main]
ignore = ["tests", "dist", "build"]
fail-under = 9.0
jobs = 0
limit-inference-results = 100
persistent = true
suggestion-mode = true

[tool.pylint.basic]
argument-naming-style = "snake_case"
attr-naming-style = "snake_case"
class-const-naming-style = "UPPER_CASE"
class-naming-style = "PascalCase"
variable-naming-style = "snake_case"
module-naming-style = "any"

[tool.pylint.format]
max-line-length = 88

[tool.pylint."messages control"]
disable = [
  "R0903", # too-few-public-methods
]

[tool.ruff]
line-length = 88
indent-width = 4
respect-gitignore = true

[tool.ruff.lint]
select = [
  "B",       # bugbear
  "D",       # pydocstyle
  "E",       # pycodestyle
  "F",       # pyflakes
  "I",       # isort
  "PYI",     # flake8-pyi
  "RUF",     # ruff
  "W",       # pycodestyle
  "PIE",     # flake8-pie
  "PGH004",  # pygrep-hooks - Use specific rule codes when using noqa
  "PLE",     # pylint error
  "PLW",     # pylint warning
  "PLR1714", # Consider merging multiple comparisons
  "UP",      # Pyupgrade
]
ignore = [
  "D102",    # undocumented-public-method (D102)
  "D105",    # undocumented-magic-method (D105)
  "D107",    # undocumented-public-init (D107)
  "D203",    # one-blank-line-before-class (D203)
  "D213",    # multi-line-summary-second-line (D213)
  "PLR0913", # too-many-arguments (PLR0913)
  "C408",    # unnecessary-collection-call (C408)
]

[tool.ruff.lint.pydocstyle]
convention = "google" # Accepts: "google" | "numpy" | "pep257"

[tool.ruff.lint.isort]
lines-after-imports = 2

[tool.ruff.lint.per-file-ignores]
"__init__.py" = [
  "E402", # Import Statement not at Top of File
  "F401", # Unused Imports
]
"tests/*.py" = [
  "D",       # PyDocstyle
  "PLR2004", # magic-value-comparison (PLR2004)
  "F841",    # unused-variable (F841)
]

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