pyproject.toml

[project]
name = "bx_py_utils"
dynamic = ["version"]
description = "Various Python utility functions"
authors = [
    {name = 'Jens Diemer', email = 'jens.diemer@boxine.de'},
    {name = 'Philipp Hagemeister', email = 'phihag@phihag.de'},
    {name = 'Florian Braun', email = 'mail@chiron-online.de'},
    {name = 'Christian Schneider', email = 'christian@cnschn.com'},
]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3 :: Only",
    "Intended Audience :: Developers",
]
license = {text = "MIT"}
keywords=["utilities"]
readme="README.md"

requires-python = ">=3.11"
dependencies = []
[dependency-groups]
dev = [
    'boto3',  # needed for e.g.: bx_py_utils/aws/ stuff!
    'requests-mock',
    'beautifulsoup4',
    'lxml',
    'pdoc',  # https://pdoc.dev/
    'freezegun',  # https://github.com/spulec/freezegun
    'openpyxl',  # https://foss.heptapod.net/openpyxl/openpyxl
    'parameterized',  # https://github.com/wolever/parameterized
    'hatchling',  # https://github.com/pypa/hatch/tree/master/backend
    "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
    "nox",  # https://github.com/wntrblm/nox
    "coverage",  # https://github.com/nedbat/coveragepy
    "ruff", # https://github.com/astral-sh/ruff
    "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
    "typeguard",  # https://github.com/agronholm/typeguard/
]

[project.urls]
Documentation = "https://github.com/boxine/bx_py_utils/"
Source = "https://github.com/boxine/bx_py_utils/"

[project.scripts]
bx_py_utils = "bx_py_utils.__main__:main"


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

[tool.hatch.build.targets.wheel]
packages = ["bx_py_utils"]

[tool.hatch.version]
path = "bx_py_utils/__init__.py"


[tool.ruff]
# https://docs.astral.sh/ruff/configuration/
line-length = 120
exclude = [
  ".*/",
]

[tool.ruff.lint]
preview = true  # Needed for some of the rules
extend-select = [
    "E", # pycodestyle: https://docs.astral.sh/ruff/rules/#error-e
    "I", # isort: https://docs.astral.sh/ruff/rules/#isort-i
]
ignore = [ # TODO: Remove ignores one by one and fix the issues
    "E402", # https://docs.astral.sh/ruff/rules/module-import-not-at-top-of-file/
    "E731", # https://docs.astral.sh/ruff/rules/lambda-assignment/
    "BLE001", # Do not catch blind exception
    "DTZ001",  # datetime without timezone
    "E402",    # https://docs.astral.sh/ruff/rules/module-import-not-at-top-of-file/
    "E731",    # https://docs.astral.sh/ruff/rules/lambda-assignment/
    "LOG015",  # Root logger call
    "PIE790",  # Unnecessary pass
    "PLR1730", # Replace `if`/`else` with min/max
    "PLW1508", # Invalid env-var default
    "RUF010",  # Use explicit conversion flag
    "RUF013",  # Implicit Optional
    "RUF100",  # Unused blanket noqa
    "SIM102",  # Nested if → single if
    "SIM103",  # Return bool condition directly
    "SIM117",  # Nested with → single with
    "SIM118",  # key in dict.keys()
    "TRY002",  # Create your own exception
    "UP017",   # datetime.timezone.utc → datetime.UTC
]

[tool.ruff.lint.isort]
# https://docs.astral.sh/ruff/settings/#lintisort
lines-after-imports = 2

[tool.ruff.format]
quote-style = "single"


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

[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.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"]


[tool.bx_py_utils.doc_write]
search_paths = ['./bx_py_utils/', './bx_py_utils_tests/']
output_base_path = '.' # Current work dir -> project root
docstring_prefix = 'DocWrite:'


[manageprojects] # https://github.com/jedie/manageprojects
initial_revision = "1f3a70e"
initial_date = 2024-05-21T21:22:39+02:00
cookiecutter_template = "https://github.com/jedie/cookiecutter_templates/"
cookiecutter_directory = "make-uv-python"
applied_migrations = [
    "dee29ef", # 2024-07-09T16:06:43+02:00
    "e9e2dae", # 2024-11-14T17:59:23+01:00
    "e259304", # 2025-06-10T08:32:49+02:00
    "730a268", # 2025-09-04T19:20:59+02:00
    "ae7c1ba", # 2025-12-16T19:28:11+01:00
]

[manageprojects.cookiecutter_context.cookiecutter]
full_name = "Jens Diemer"
github_username = "jedie"
author_email = "jens.diemer@boxine.de"
package_name = "bx_py_utils"
package_version = "71"
package_description = "Various Python utility functions"
package_url = "https://github.com/boxine/bx_py_utils"
issues_url = "https://github.com/boxine/bx_py_utils/issues"
license = "MIT"
_template = "https://github.com/jedie/cookiecutter_templates/"