pyproject.toml

[project]
name = "python-project-template"
license = "BSD-3-Clause"
license-files = ["LICENSE", "CITATION.bib"]
readme = "README.md"
authors = [
    { name = "LINCC Frameworks", email = "lincc-frameworks-team@lists.lsst.org" }
]
description = "LINCC-Framework's best practices for python code organization, testing, documentation, and automation."
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
]
dynamic = ["version"]
requires-python = ">=3.9"
dependencies = [
    "setuptools_scm",
    "pyyaml-include<3.0",
]

[project.urls]
"Source Code" = "https://github.com/lincc-frameworks/python-project-template"

# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
[project.optional-dependencies]
dev = [
    "black", # Used to format code
    "pre-commit", # Used to run checks prior to committing code
    "pytest", # Used to run tests
    "pytest-cov", # Used to measure test coverage
    "pylint", # test pylint in unit tests
    "pytest-copie", # Used to create hydrated copier projects for testing
    "tox", # Used to run tests in multiple environments
    ## Dependencies that are needed to test hydrated projects:
    "ipykernel",
    "ipython",
    "jupyter",
    "jupytext",
    "mypy",
    "nbconvert",
    "nbsphinx",
    "pre-commit",
    "ruff",
    "sphinx",
    "sphinx-autoapi",
    "sphinx-copybutton",
    "sphinx-rtd-theme>=3.0",
]

[build-system]
requires = [
    "setuptools>=62", # Used to build and package the Python project
    "setuptools_scm>=6.2", # Gets release version from git. Makes it available programmatically
]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
write_to = "_version.py"

[tool.black]
line-length = 110

[tool.isort]
profile = "black"
line_length = 110