pyproject.toml

[project]
name = "saritasa-invocations"
dynamic = [
  "version",
]
description = "Collection of invoke commands used by Saritasa"
authors = [
  {name = "Saritasa", email = "pypi@saritasa.com"}
]
maintainers = [
    {name = "Stanislav Khlud", email = "stanislav.khlud@saritasa.com"}
]
keywords = [
  "python",
  "invoke"
]
license = "MIT"
readme = "README.md"
classifiers = [
  "License :: OSI Approved :: MIT License",
  "Natural Language :: English",
  "Intended Audience :: Developers",
  "Operating System :: OS Independent",
  "Topic :: Software Development :: Libraries :: Python Modules",
  "Development Status :: 5 - Production/Stable",
  "Environment :: Console",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
]
requires-python = ">=3.10"
dependencies = [
  # Invoke is a Python (2.7 and 3.4+) task execution tool & library,
  # drawing inspiration from various sources to arrive at a powerful & clean feature set.
  # http://www.pyinvoke.org/
  "invoke>=2",
  # Rich is a Python library for writing rich text (with color and style) to the terminal,
  # and for displaying advanced content such as tables, markdown, and syntax highlighted code.
  # https://rich.readthedocs.io/en/stable/introduction.html
  "rich>=13",
]

[project.optional-dependencies]
env-settings = [
  # Decouple helps you to organize your settings so that you can change
  # parameters without having to redeploy your app.
  # Used to get settings from .env files
  # https://github.com/HBNetwork/python-decouple
  "python-decouple>=3",
]

[dependency-groups]
local = [
  "ipython",
  # Exports functions to access the IPython debugger, which features tab completion, syntax highlighting, better tracebacks
  # https://github.com/gotcha/ipdb
  "ipdb",
  # A fast Git hook manager written in Rust, designed as a drop-in alternative to pre-commit, reimagined.
  # https://prek.j178.dev/
  "prek",
  # Collection of invoke commands which used in Saritasa organization
  # https://github.com/saritasa-nest/saritasa-python-invocations/
  "saritasa-invocations[env_settings]",
  # A library and CLI app for rendering project templates.
  # https://copier.readthedocs.io/en/latest/
  "copier",
]
linters = [
  # Mypy is a static type checker for Python.
  # https://mypy.readthedocs.io/en/stable/
  "mypy",
]
docs = [
  # Project documentation with Markdown.
  # https://www.mkdocs.org/
  "mkdocs",
  # A powerful documentation framework on top of MkDocs
  # https://squidfunk.github.io/mkdocs-material/
  "mkdocs-material",
  # Automatic documentation from sources, for MkDocs
  # https://mkdocstrings.github.io/
  "mkdocstrings[python]",
  # Manage multiple versions of your MkDocs-powered documentation
  # https://github.com/jimporter/mike
  "mike",
]

[project.scripts]
# For testing locally
# uvx --with=mypy . pre-commit.run-hooks
saritasa-invocations = "invoke.main:program.run"
saritasa-inv = "invoke.main:program.run"

[project.urls]
Documentation = "https://saritasa-nest.github.io/saritasa-invocations/latest/"
Repository = "https://github.com/saritasa-nest/saritasa-invocations"
Changelog = "https://saritasa-nest.github.io/saritasa-invocations/latest/changelog/"
Releases = "https://github.com/saritasa-nest/saritasa-invocations/releases/"
"Bug Tracker" = "https://github.com/saritasa-nest/saritasa-invocations/issues/"
Contributing ="https://saritasa-nest.github.io/saritasa-invocations/latest/contributing/"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[tool.hatch.version]
# https://regex101.com/r/b6WRcJ/1
pattern = "(?<=^## )(?P<version>(\\d{1,2}\\.\\d{1,2}\\.\\d{1,3})).*$"
path = "CHANGELOG.md"
[tool.hatch.build.targets.wheel]
packages = [
  "saritasa_invocations"
]

[tool.ruff]
line-length = 79
indent-width = 4

[tool.ruff.lint]
extend-select = [
  # https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
  "W",
  "E",
  # https://docs.astral.sh/ruff/rules/#mccabe-c90
  "C90",
  # https://docs.astral.sh/ruff/rules/#isort-i
  "I",
  # https://docs.astral.sh/ruff/rules/#pep8-naming-n
  "N",
  # https://docs.astral.sh/ruff/rules/#pydocstyle-d
  "D",
  # https://docs.astral.sh/ruff/rules/#pyupgrade-up
  "UP",
  # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
  "ANN",
  # https://docs.astral.sh/ruff/rules/#flake8-bandit-s
  "S",
  # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
  "B",
  # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
  "A",
  # https://docs.astral.sh/ruff/rules/#flake8-commas-com
  "COM",
  # https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
  "C4",
  # https://docs.astral.sh/ruff/rules/#flake8-datetimez-dtz
  "DTZ",
  # https://docs.astral.sh/ruff/rules/#flake8-debugger-t10
  "T10",
  # https://docs.astral.sh/ruff/rules/#flake8-print-t20
  "T20",
  # https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
  "PT",
  # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
  "SIM",
  # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
  "PTH",
  # https://docs.astral.sh/ruff/rules/#flake8-todos-td
  "TD",
  # https://docs.astral.sh/ruff/rules/#eradicate-era
  "ERA",
  # https://docs.astral.sh/ruff/rules/#tryceratops-try
  "TRY",
  # https://docs.astral.sh/ruff/rules/#flynt-fly
  "FLY",
  # https://docs.astral.sh/ruff/rules/#perflint-perf
  "PERF",
  # https://docs.astral.sh/ruff/rules/#refurb-furb
  "FURB",
  # https://docs.astral.sh/ruff/rules/#flake8-pie-pie
  "PIE",
  # https://docs.astral.sh/ruff/rules/#flake8-async-async
  "ASYNC",
  # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
  "RUF",
]
ignore = [
  # https://docs.astral.sh/ruff/rules/any-type
  "ANN401",
  # https://docs.astral.sh/ruff/rules/missing-type-kwargs
  "ANN003",
  # https://docs.astral.sh/ruff/rules/undocumented-public-module
  "D100",
  # https://docs.astral.sh/ruff/rules/undocumented-public-package
  "D104",
  # https://docs.astral.sh/ruff/rules/undocumented-public-nested-class
  "D106",
  # https://docs.astral.sh/ruff/rules/undocumented-public-init
  "D107",
  # https://docs.astral.sh/ruff/rules/raise-vanilla-args
  "TRY003",
  # https://docs.astral.sh/ruff/rules/try-consider-else
  "TRY300",
]
[tool.ruff.lint.per-file-ignores]
"__init__.py" = [
  # https://docs.astral.sh/ruff/rules/unused-import
  "F401",
]
"**/tests/*" = [
  # https://docs.astral.sh/ruff/rules/assert
  "S101",
  # https://docs.astral.sh/ruff/rules/hardcoded-password-func-arg
  "S106",
  # https://docs.astral.sh/ruff/rules/suspicious-non-cryptographic-random-usage
  "S311",
]
"**/test_*" = [
  # https://docs.astral.sh/ruff/rules/missing-return-type-undocumented-public-function
  "ANN201",
]
[tool.ruff.lint.isort]
force-wrap-aliases = true
split-on-trailing-comma = true
section-order = [
  "future",
  "standard-library",
  "third-party",
  "first-party",
  "local-folder",
]

[tool.ruff.lint.flake8-pytest-style]
fixture-parentheses = false
parametrize-names-type = "list"
parametrize-values-type = "list"
parametrize-values-row-type = "list"

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

[tool.mypy]
# https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
ignore_missing_imports = true
strict = false
warn_no_return = false
check_untyped_defs = true
disallow_any_generics = true
exclude = "venv|/.venv"