Sandbox::https://github.com/python-semantic-release/python-semantic-release/blob/master/pyproject.toml

Repository navigation

475 lines (425 loc) · 11.2 KB
# Ref: https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
# and https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
[build-system]
requires = ["setuptools >= 75.3.0, < 85.0.0", "wheel ~= 0.42"]
build-backend = "setuptools.build_meta"
name = "python-semantic-release"
version = "10.7.0"
description = "Automatic Semantic Versioning for Python projects"
requires-python = "~= 3.8"
license = { text = "MIT" }
classifiers = [
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.8",
  "Programming Language :: Python :: 3.9",
  "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",
readme = "README.rst"
authors = [
  { name = "Rolf Erik Lekang", email = "me@rolflekang.com" },
  { name = "codejedi365", email = "codejedi365@gmail.com" },
dependencies = [
  "click ~= 8.1.0; python_version == '3.8'",
  "click ~= 8.1.0; python_version == '3.9'",
  "click >= 8.1.0, < 8.6.0; python_version >= '3.10'",
  "click-option-group ~= 0.5.0",
  "gitpython ~= 3.0",
  "requests ~= 2.25",
  "jinja2 ~= 3.1",
  "python-gitlab ~= 4.0; python_version == '3.8'",
  "python-gitlab >= 4.0.0, < 7.0.0; python_version == '3.9'",
  "python-gitlab >= 4.0.0, < 9.0.0; python_version >= '3.10'",
  "tomlkit ~= 0.13.0; python_version == '3.8'",
  "tomlkit ~= 0.15.0; python_version >= '3.9'",
  "dotty-dict ~= 1.3",
  "importlib-resources ~= 6.0; python_version == '3.8'",  # add backport for Python 3.8
  "pydantic ~= 2.0",
  "rich ~= 14.0; python_version == '3.8'",
  "rich ~= 15.0; python_version >= '3.9'",
  "shellingham ~= 1.5",
  "Deprecated ~= 1.2",  # Backport of deprecated decorator for python 3.8
[project.scripts]
python-semantic-release = "semantic_release.__main__:main"
semantic-release = "semantic_release.__main__:main"
psr = "semantic_release.__main__:main"
[project.urls]
changelog = "https://python-semantic-release.readthedocs.io/en/stable/misc/psr_changelog.html"
documentation = "https://python-semantic-release.readthedocs.io"
homepage = "https://python-semantic-release.readthedocs.io"
issues = "https://github.com/python-semantic-release/python-semantic-release/issues"
repository = "http://github.com/python-semantic-release/python-semantic-release.git"
[project.optional-dependencies]
  "build ~= 1.2",
  "tomlkit ~= 0.13.0; python_version == '3.8'",
  "tomlkit ~= 0.15.0; python_version >= '3.9'",
  "Sphinx ~= 7.4",
  "sphinxcontrib-apidoc == 0.6.0",
  "sphinx-autobuild == 2024.2.4",
  "furo ~= 2025.9",
  "coverage[toml] ~= 7.0",
  "filelock >= 3.15, < 5.0",
  "cj365-flatdict ~= 5.0",
  "freezegun ~= 1.5",
  "pyyaml ~= 6.0",
  "pytest >= 8.3, < 10.0",
  "pytest-clarity ~= 1.0",
  "pytest-cov >= 5.0.0, < 8.0.0",
  "pytest-env ~= 1.0",
  "pytest-lazy-fixtures ~= 1.4",
  "pytest-mock ~= 3.0",
  "pytest-order ~= 1.3",
  "pytest-pretty ~= 1.2",
  "pytest-xdist ~= 3.0",
  "responses ~= 0.26.2",
  "requests-mock ~= 1.10",
  "pre-commit >= 3.5.0, < 5.0.0",
  "tox ~= 4.11",
  "ruff == 0.6.1"
  "mypy >= 1.14.1, < 2.0.0",
  "types-Deprecated ~= 1.2",
  "types-requests >= 2.32.0, < 3.0.0",
  "types-pyyaml ~= 6.0",
[tool.setuptools]
include-package-data = true
[tool.setuptools.packages.find]
where = ["src"]
[tool.pytest.ini_options]
  "PYTHONHASHSEED = 123456"
addopts = [
  # TO DEBUG in single process, swap auto to 0
  # "-nauto",
  "--diff-symbols",
  "--durations=20",
  # No default coverage - causes problems with debuggers
  # "--cov=semantic_release",
  # "--cov-context=test",
  # "--cov-report=html:coverage-html",
  # "--cov-report=term-missing",
testpaths = [
markers = [
  "unit: mark a test as a unit test",
  "e2e: mark a test as a end-to-end test",
  "comprehensive: mark a test as a comprehensive (multiple variations) test",
[tool.coverage.html]
show_contexts = true
[tool.coverage.run]
omit = ["*/tests/*"]
[tool.bandit]
targets = ["semantic_release"]
legacy_tox_ini = """
    py{38,39,310,311,312},
    coverage
skipsdist = True
passenv = CI
    PYTHONPATH = {toxinidir}
    TESTING = True
deps = .[test]
    coverage run -p --source=semantic_release -m pytest {posargs:tests}
[testenv:mypy]
deps = .[mypy]
[testenv:coverage]
deps = coverage[toml]
    coverage combine
    coverage report -m
    coverage xml
[testenv:ruff]
deps = .[dev]
    ruff check . --statistics
[tool.mypy]
show_column_numbers = true
show_error_context = true
pretty = true
error_summary = true
follow_imports = "normal"
enable_error_code = ["ignore-without-code"]
disallow_untyped_calls = true
# warn_return_any = true
strict_optional = true
warn_no_return = true
warn_redundant_casts = true
# warn_unused_ignores = true
warn_unused_configs = true
# warn_unreachable = true
disallow_untyped_defs = true
check_untyped_defs = true
cache_dir = "/dev/null"
plugins = ["pydantic.mypy"]
[[tool.mypy.overrides]]
module = "tests.*"
disallow_untyped_defs = false
[[tool.mypy.overrides]]
module = "shellingham"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "dotty_dict"
ignore_missing_imports = true
[tool.ruff]
line-length = 88
target-version = "py38"
force-exclude = true
output-format = "grouped"
show-fixes = true
src = ["semantic_release", "tests"]
[tool.ruff.lint]
select = ["ALL"]
# See https://docs.astral.sh/ruff/rules/
# for any of these codes you can also run `ruff rule [CODE]`
# which explains it in the terminal
  # attribute shadows builtin (e.g. Foo.list())
  # Annotations (flake8-annotations)
  # missing "self" type-hint
  "ANN101",
  "ANN102",
  "ANN401",
  # flake8-bugbear
  # flake8-commas
  # Missing docstrings - eventually want to enable
  # flake8-datetimez
  # flake8-errmsg
  # Some todos and some examples; leave this disabled for now
  "ERA001",
  # don't compare types, use isinstance()
  # sometimes using type(x) == y is deliberately chosen to exclude
  # subclasses
  # flake8-fixme
  # flake8-boolean-trap
  # No implicit packages
  "INP001",
  # Errors should end with "Error"
  # mypy prevents blanket-type-ignore
  "PGH003",
  # Fixtures that do not return a value need an underscore prefix.  The rule
  # does not handle generators.
  # flake8-pytest-style, values rowtype (list|tuple)
  # pytest.raises needs a match - eventually want to enable
  "PLE1507",
  # flake8-use-pathlib
  # flake8-raise
  # This seems to flag a load of false-positives, thinking that the # noqa's are
  # unneeded and trying to fix them even though ruff then flags the errors that
  # were previously ignored
  "RUF100",
  # flake8-todos
  # tryceratops
  "TRY003",
  "TRY401",
  # other errors that conflict with ruff format
  # indentation-with-invalid-multiple
  "COM812",
  "COM812",
  "ISC001",
  "ISC002",
external = ["V"]
task-tags = ["NOTE", "TODO", "FIXME", "XXX"]
[tool.ruff.format]
docstring-code-format = true
indent-style = "space"
line-ending = "lf"
quote-style = "double"
[tool.ruff.lint.per-file-ignores]
# Imported but unused
"__init__.py" = ["F401"]
# pydantic 1 can't handle __future__ annotations-enabled syntax on < 3.10
"src/semantic_release/cli/config.py" = ["UP", "TCH"]
"src/semantic_release/commit_parser/*" = ["UP", "FA", "TCH"]
# Method argument not used. This is mostly a base class
"src/semantic_release/hvcs/_base.py" = ["ARG002"]
# from tests.fixtures import * is deliberate
"tests/conftest.py" = ["F403"]
"tests/fixtures/**/__init__.py" = ["F403"]
"tests/*" = [
  # unused arguments - likely fixtures to be moved to
  # @pytest.mark.usefixtures
  "ARG001",
  # "assert" used
  # possible hard-coded password assigned to argument
  # because we use "prerelease_token=..." and bandit panics
  # when it sees *_token variables
  # pseudo-random generators not suitable for cryptographic purposes
  # (e.g. random.choice used)
  # Private member access
  "SLF001",
  # Annotations
  # Using format instead of f-string for readablity
[tool.ruff.lint.mccabe]
max-complexity = 10
[tool.ruff.lint.flake8-implicit-str-concat]
allow-multiline = true
[tool.ruff.lint.flake8-quotes]
inline-quotes = "double"
multiline-quotes = "double"
[tool.ruff.lint.flake8-tidy-imports]
ban-relative-imports = "all"
[tool.ruff.lint.flake8-type-checking]
strict = true
[tool.ruff.lint.flake8-pytest-style]
fixture-parentheses = false
mark-parentheses = false
parametrize-names-type = "csv"
[tool.ruff.lint.isort]
# required-imports = ["from __future__ import annotations"]
combine-as-imports = true
known-first-party = ["semantic_release"]
forced-separate = ["tests"]
relative-imports-order = "closest-to-furthest"
section-order = [
  "future",
  "standard-library",
  "third-party",
  "first-party",
  "local-folder",
sections = { "tests" = ["tests"] }
[tool.vulture]
ignore_names = ["change_to_ex_proj_dir", "init_example_project"]
[tool.semantic_release]
add_partial_tags = true
logging_use_named_masks = true
commit_parser = "conventional"
commit_parser_options = { parse_squash_commits = true, ignore_merge_commits = true }
commit_message = """\
chore: release v{version}
Automatically generated by python-semantic-release
build_command = """
    python -m pip install -e .[build]
    python -m build .
major_on_zero = true
version_variables = [
  "src/gh_action/requirements.txt:python-semantic-release:nf",
  "docs/configuration/automatic-releases/github-actions.rst:python-semantic-release/python-semantic-release@COMMIT_HASH  #:tf",
  "docs/configuration/automatic-releases/github-actions.rst:python-semantic-release/publish-action@COMMIT_HASH  #:tf",
version_toml = ["pyproject.toml:project.version"]
[tool.semantic_release.changelog]
# default_templates = { changelog_file = "CHANGELOG.rst" }
exclude_commit_patterns = [
  '''chore(?:\([^)]*?\))?: .+''',
  '''ci(?:\([^)]*?\))?: .+''',
  '''refactor(?:\([^)]*?\))?: .+''',
  '''style(?:\([^)]*?\))?: .+''',
  '''test(?:\([^)]*?\))?: .+''',
  '''build\((?!deps\): .+)''',
  '''Merged? .*''',
  '''Initial Commit.*''',
  # Old semantic-release version commits
  '''^\d+\.\d+\.\d+''',
insertion_flag = "=========\nCHANGELOG\n========="
mode = "update"
template_dir = "config/release-templates"
[tool.semantic_release.branches.main]
match = "^(main|master)$"
prerelease = false
prerelease_token = "rc"
[tool.semantic_release.branches.alpha]
match = "^(feat|fix|perf)/.+"
prerelease = true
prerelease_token = "alpha"
[tool.semantic_release.branches.dev]
match = ".+"
prerelease = true
prerelease_token = "dev"
[tool.semantic_release.remote]
type = "github"
token = { env = "GH_TOKEN" }
[tool.semantic_release.publish]
upload_to_vcs_release = true
FilesExpand file tree

pyproject.toml

Latest commit

History

pyproject.toml

File metadata and controls
