pyproject.toml

####################################################################################################
# -------------------------------------------  Project  ------------------------------------------ #
####################################################################################################

[project]
name = "python_template_repo"
version = "0.0.0"
authors = [{name = "Lennard Wolf", email = "7870758+MultifokalHirn@users.noreply.github.com"}]
description = """ \
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, \
    sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. \
    Ut enim ad minim veniam, quis nostrud exercitation ullamco \
    laboris nisi ut aliquip ex ea commodo consequat.\
"""
keywords = ["template"]
license = {file = "LICENSE"}
maintainers = [{name = "Lennard Wolf", email = "7870758+MultifokalHirn@users.noreply.github.com"}]
readme = {content-type = "text/markdown", file = "README.md"}
classifiers = [
  "Development Status :: 3 - Alpha",
  "Intended Audience :: Developers",
  "Topic :: Software Development :: Libraries :: Python Modules",
  "Topic :: Utilities",
  "Operating System :: MacOS :: MacOS X",
  "Operating System :: POSIX",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
]
dependencies = [
    # "importlib-metadata",
    "pydantic",
    "ruamel-yaml",
    "termcolor",
    "typing-extensions",
    "devtools",
    # "pyboxen>=1.2.0",
]
requires-python = ">=3.11"
[project.optional-dependencies]
all-dev = [
  "pdm[qa,docs,lint,refactoring,test]",
]
qa = [
  "pre-commit",
  "commitizen",
]
docs = [
  "furo",
  "sphinx",
  "sphinx-autodoc-typehints",
]
lint = [
  "ruff",
  "mypy",
  "mypy-extensions",
]
refactoring = [
  "pyupgrade>=3.15.0",
]
test = [
  "covdefaults>=2.3",
  "coverage-badge",
  "coverage[toml]",
  "pytest-mypy",
  "pytest-xdist",
  "pytest",
  "types-mock",
]
[project.urls]
Changelog = "https://github.com/MultifokalHirn/python_template_repo/blob/main/CHANGELOG/"
Homepage = "https://github.com/MultifokalHirn/python_template_repo"
Repository = "https://github.com/MultifokalHirn/python_template_repo"
# Documentation = "https://"

[project.scripts]
# cli = "python_template_repo.cli:main"

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


####################################################################################################
# ------------------------------------------  SCRIPTS  ------------------------------------------- #
####################################################################################################


[tool.pdm.scripts]
_.env_file = ".env"
# Dependency management
lock = {shell = """ \
                  pdm lock -G :all \
                  && source .venv/bin/activate \
                  && pdm sync \
                """}
update-all = {shell = """ \
                        printf 'Updating all dependencies...' \
                        && pdm lock -G :all \
                        && pdm update -G :all \
                        && pdm export -o requirements.txt --without-hashes --prod \
                        && pdm export -o requirements-dev.txt --without-hashes -dG all-dev \
                        && printf '\t✅\n' || printf '\t❌\n' \
                      """}
# CI: format, lint, mypy, test
format = {shell = """ \
                    printf 'Formatting...' \
                    && .venv/bin/ruff --config=./pyproject.toml --fix src/ tests/ \
                    && printf '\t\t✅\n' || printf '\t\t❌\n' \
                  """}
lint = {shell = """ \
                  printf 'Linting...' \
                  && .venv/bin/ruff check --config=./pyproject.toml src/ tests/ \
                  && printf '\t\t✅\n' || printf '\t\t❌\n' \
                """}
mypy = {shell = """ \
                  printf 'Type-checking...' \
                  && .venv/bin/mypy --no-error-summary --install-types --config-file=./pyproject.toml \
                  && printf '\t✅\n' || printf '\t❌\n' \
                """}
test = {shell = """ \
                  printf 'Running tests...' \
                  && .venv/bin/coverage run -m pytest tests/ --show-capture=log -p no:logging -p no:warnings \
                  && .venv/bin/coverage report \
                  && .venv/bin/coverage-badge -o docs/public/img/coverage.svg -f \
                """}
ci = {shell = """ \
                pdm run format; \
                pdm run lint; \
                pdm run mypy; \
                pdm run test; \
                pdm run docs \
              """}
docs = {shell = """ \
                  printf 'Building documentation...';
                  make build-docs && printf '\t✅\n' || printf '\t❌\n' \
                """}

####################################################################################################
# --------------------------------------------  TOOLS  ------------------------------------------- #
####################################################################################################


[tool.mypy]
plugins = ["pydantic.mypy"]
disallow_any_unimported = false
ignore_missing_imports = true
pretty = true
# install_types = true # pre-commit has issues with this, so we use this as flag in the script
python_version = "3.11"
show_error_codes = true
strict = true
warn_redundant_casts = true
warn_unused_ignores = false
files = ["src/**/*.py"]
exclude = ["tests/**/*.py", "docs/**/*.py"]

[tool.pydantic-mypy]
init_forbid_extra = true
init_typed = true
warn_required_dynamic_aliases = true

[tool.coverage.run]
source = ["src/python_template_repo"]
branch = true
# parallel = true
plugins = ["covdefaults"]
omit = [
  "tests/*",
  "docs/*",
  "*/.venv/*",
]

[tool.coverage.report]
exclude_lines = [
  "pragma: no cover",
  "if __name__ == .__main__.:",
  "def __repr__",
  "raise NotImplementedError",

]
fail_under = 99
omit = [
  "tests/*",
  "docs/*",
  "*/.venv/*",
]
show_missing = true
skip_covered = false
sort = "Cover"

[tool.commitizen]
version = "0.0.0"
version_files = [
  "src/python_template_repo/__version__.py",
  "pyproject.toml:version",
]

[tool.ruff]
# Exclude a variety of commonly ignored directories.
exclude = [
  ".bzr",
  ".direnv",
  ".eggs",
  ".git",
  ".git-rewrite",
  ".hg",
  ".mypy_cache",
  ".nox",
  ".pants.d",
  ".pytype",
  ".ruff_cache",
  ".tox",
  ".venv",
  "__pypackages__",
  "_build",
  "buck-out",
  "build",
  "node_modules",
  "dist",
]
indent-width = 4
line-length = 127
# Assume Python 3.12
target-version = "py312"

[tool.ruff.lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
ignore = []
select = ["E4", "E7", "E9", "F"]
# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
[tool.ruff.format]
# Like Black, use double quotes for strings.
quote-style = "double"
# Like Black, indent with spaces, rather than tabs.
indent-style = "space"
# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false
# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

[tool.ruff.per-file-ignores]
"tests/**/*.py" = [
  "S101", # asserts allowed in tests...
  "FBT", # don"t care about booleans as positional arguments in tests
  "INP001", # no implicit namespace
  "D", # don"t care about documentation in tests
  "S603", # `subprocess` call: check for execution of untrusted input
  "PLR2004", # Magic value used in comparison, consider replacing with a constant variable
]

[tool.pdm]
# version = {from = "src/python_template_repo/__init__.py"}

[tool.pdm.build]
excludes = ["./**/.git"]
includes = ["src/**/*", "pyproject.toml", "LICENSE", "README.md"]
package-dir = "src"
source-includes = ["tests", "CHANGELOG.md", "LICENSE", "README.md"]

[tool.pytest.ini_options]
filterwarnings = ["ignore::DeprecationWarning"]
# cov = ["src/python_template_repo"]
# addopts = "--cov=python_template_repo --cov-report html"