pyproject.toml

[project]
name = "cli-base-utilities"
dynamic = ["version"]
description = "Helpers to bild a CLI program"
license = {text = "GPL-3.0-or-later"}
readme = "README.md"
authors = [
    {name = 'Jens Diemer', email = 'github@jensdiemer.de'}
]
requires-python = ">=3.11"
dependencies = [
    "bx_py_utils",  # https://github.com/boxine/bx_py_utils
    "tomlkit",  # https://github.com/sdispater/tomlkit
    "tyro",  # https://github.com/brentyi/tyro
    "click",  # For Backward compatibility TODO: Remove in future
    "rich",  # https://github.com/Textualize/rich
    "packaging",  # https://github.com/pypa/packaging
    "python-dateutil",  # https://github.com/dateutil/dateutil/
]

[dependency-groups]
dev = [
    "manageprojects",  # https://github.com/jedie/manageprojects
    "urllib3", # for bx_py_utils.test_utils.deny_requests.deny_any_real_request() in tests
    "uv",  # https://github.com/astral-sh/uv
    "setuptools",  # https://github.com/pypa/setuptools
    "build",  # https://github.com/pypa/build
    "tox",  # https://github.com/tox-dev/tox
    "tox-uv",  # https://github.com/tox-dev/tox-uv
    "coverage",  # https://github.com/nedbat/coveragepy
    "autopep8",  # https://github.com/hhatto/autopep8
    "pyupgrade",  # https://github.com/asottile/pyupgrade
    "flake8",  # https://github.com/pycqa/flake8
    "flake8-bugbear",  # https://github.com/PyCQA/flake8-bugbear
    "pyflakes",  # https://github.com/PyCQA/pyflakes
    "codespell",  # https://github.com/codespell-project/codespell
    "EditorConfig",  # https://github.com/editorconfig/editorconfig-core-py
    "pip-audit",  # https://github.com/pypa/pip-audit
    "mypy",  # https://github.com/python/mypy
    "twine",  # https://github.com/pypa/twine
    "pre-commit",  # https://github.com/pre-commit/pre-commit
    "typeguard",  # https://github.com/agronholm/typeguard/

    # https://github.com/akaihola/darker
    # https://github.com/ikamensh/flynt
    # https://github.com/pycqa/isort
    # https://github.com/pygments/pygments
    "darker[flynt, isort, color]",

    # Work-a-round for: https://github.com/jazzband/pip-tools/issues/1866
    # see also: https://github.com/jazzband/pip-tools/issues/994#issuecomment-1321226661
    # backports.tarfile is needed for python <3.12
    'backports.tarfile', # via jaraco-context -> keyring -> twine
]

[project.urls]
Documentation = "https://github.com/jedie/cli-base-utilities"
Source = "https://github.com/jedie/cli-base-utilities"

[project.scripts]
cli_base_app = "cli_base.__main__:main"
cli_base_dev = "cli_base.cli_dev:main"

[build-system]
requires = ["setuptools>=61.0", "setuptools_scm>=7.1"]
build-backend = "setuptools.build_meta"

[tool.setuptools.packages.find]
where = ["."]
include = ["cli_base*"]

[tool.setuptools.dynamic]
version = {attr = "cli_base.__version__"}


[tool.cli_base]
version_module_name = "cli_base" # Used in cli_base.cli_tools.git_history.update_readme_history()


[tool.cli_base.pip_audit]
requirements=["requirements.dev.txt"]
strict=true
require_hashes=true
ignore-vuln=[]


[tool.bx_py_utils.doc_write]
docstring_prefix = 'DocWrite:'
output_base_path = './docs/'
search_paths = ['./cli_base/']
delete_obsolete_files = true  # Delete obsolete files in output_base_path


[tool.darker]
src = ['.']
revision = "origin/main..."
line_length = 119
color = true
skip_string_normalization = true
diff = false
check = false
stdout = false
isort = true
log_level = "INFO"


[tool.isort]
# https://pycqa.github.io/isort/docs/configuration/config_files/#pyprojecttoml-preferred-format
atomic=true
profile='black'
skip_glob=['.*', '*/htmlcov/*']
known_first_party=['cli_base']
line_length=119
lines_after_imports=2


[tool.coverage.run]
branch = true
parallel = true
concurrency = ["multiprocessing"]
source = ['.']
command_line = '-m unittest --verbose --locals --buffer'

[tool.coverage.report]
omit = ['.*', '*/tests/*']
skip_empty = true
fail_under = 30
show_missing = true
exclude_lines = [
    'if self.debug:',
    'pragma: no cover',
    'raise NotImplementedError',
    'if __name__ == .__main__.:',
]


[tool.tox]  # https://tox.wiki/en/latest/config.html#pyproject-toml
isolated_build = true
env_list = ["3.13", "3.12", "3.11"]
skip_missing_interpreters = true

[tool.tox.env_run_base]
runner = "uv-venv-lock-runner"
with_dev = true
commands = [
    ["python3", "-m", "coverage", "run", "--context", "'{envname}'"]
]


[tool.mypy]
warn_unused_configs = true
ignore_missing_imports = true
allow_redefinition = true  # https://github.com/python/mypy/issues/7165
show_error_codes = true
plugins = []
exclude = ['.venv', 'tests']


[manageprojects] # https://github.com/jedie/manageprojects
initial_revision = "a264778"
initial_date = 2023-05-07T13:44:43+02:00
cookiecutter_template = "https://github.com/jedie/cookiecutter_templates/"
cookiecutter_directory = "uv-python"
applied_migrations = [
    "034be26", # 2023-08-05T21:37:12+02:00
    "9a6c2db", # 2023-11-30T20:56:46+01:00
    "2f938fc", # 2024-01-16T17:26:31+01:00
    "a20f0e3", # 2024-03-12T06:17:20+01:00
    "f8be3e0", # 2024-07-16T19:35:26+02:00
    "2cdc1d8", # 2024-08-25T19:00:41+02:00
    "ae7c1d3", # 2024-09-25T22:26:25+02:00
    "e9e2dae", # 2024-11-14T17:59:23+01:00
]

[manageprojects.cookiecutter_context.cookiecutter]
full_name = "Jens Diemer"
github_username = "jedie"
author_email = "github@jensdiemer.de"
package_name = "cli_base"
package_version = "0.0.1"
package_description = "Helpers to bild a CLI program"
package_url = "https://github.com/jedie/cli-base-utilities"
issues_url = "https://github.com/jedie/cli-base-utilities/issues"
license = "GPL-3.0-or-later"
_template = "https://github.com/jedie/cookiecutter_templates/"