pyproject.toml

[project]
name = "vcspull"
version = "1.67.0"
description = "Manage and sync multiple git, mercurial, and svn repos"
requires-python = ">=3.10,<4.0"
license = { text = "MIT" }
authors = [
  {name = "Tony Narlock", email = "tony@git-pull.com"}
]
classifiers = [
  "Development Status :: 4 - Beta",
  "License :: OSI Approved :: MIT License",
  "Environment :: Web Environment",
  "Intended Audience :: Developers",
  "Operating System :: POSIX",
  "Operating System :: MacOS :: MacOS X",
  "Programming Language :: Python",
  "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",
  "Topic :: Utilities",
  "Topic :: System :: Shells",
]
packages = [
  { include = "*", from = "src" },
]
include = [
  { path = "tests", format = "sdist" },
  { path = ".tmuxp.yaml", format = "sdist" },
  { path = "docs", format = "sdist" },
  { path = "examples", format = "sdist" },
  { path = "conftest.py", format = "sdist" },
]
readme = 'README.md'
keywords = [
  "vcspull",
  "vcs",
  "git",
  "svn",
  "subversion",
  "hg",
  "mercurial",
  "manage",
  "manager",
  "sync",
  "fetcher",
  "updater",
  "json",
  "yaml",
]
homepage = "https://vcspull.git-pull.com"
dependencies = [
  "libvcs>=0.46.0,<0.47.0",
  "colorama>=0.3.9",
  "PyYAML>=6.0"
]

[project-urls]
"Bug Tracker" = "https://github.com/vcs-python/vcspull/issues"
Documentation = "https://vcspull.git-pull.com"
Repository = "https://github.com/vcs-python/vcspull"
Changes = "https://github.com/vcs-python/vcspull/blob/master/CHANGES"

[project.scripts]
vcspull = "vcspull:cli.cli"

[dependency-groups]
dev = [
  # Docs
  "gp-sphinx==0.1.0a37",
  "sphinx-autodoc-argparse==0.1.0a37",
  "sphinx-autodoc-api-style==0.1.0a37",
  "gp-libs>=0.0.19",
  "sphinx-autobuild",
  # Testing
  "gp-libs>=0.0.19",
  "pytest",
  "syrupy",
  "pytest-asyncio",
  "pytest-rerunfailures",
  "pytest-mock",
  "pytest-watcher",
  # Coverage
  "codecov",
  "coverage",
  "pytest-cov",
  # Lint
  "ruff>=0.16.1",
  "mypy",
  # Annotations
  "types-docutils",
  "types-Pygments",
  "types-requests",
  "types-PyYAML",
  "types-colorama"
]

docs = [
  "gp-sphinx==0.1.0a37",
  "sphinx-autodoc-argparse==0.1.0a37",
  "sphinx-autodoc-api-style==0.1.0a37",
  "gp-libs>=0.0.19",
  "sphinx-autobuild",
]
testing = [
  "gp-libs>=0.0.19",
  "pytest",
  "syrupy",
  "pytest-asyncio",
  "pytest-rerunfailures",
  "pytest-mock",
  "pytest-watcher",
]
coverage =[
  "codecov",
  "coverage",
  "pytest-cov",
]
lint = [
  "ruff>=0.16.1",
  "mypy",
]
typings = [
  "types-docutils",
  "types-Pygments",
  "types-requests",
  "types-PyYAML",
  "types-colorama"
]

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

[tool.uv.exclude-newer-package]
# vcspull's release cadence is tightly coupled to libvcs -- a libvcs
# release blocking on a 3-day cooldown blocks every contributor's
# ``uv sync`` until the cooldown clears. ``false`` exempts libvcs from
# any ``exclude-newer`` constraint (global or per-user) without
# committing a date that would age into the lockfile.

gp-libs = false
gp-furo-theme = false
gp-sphinx = false
libvcs = false
sphinx-autodoc-api-style = false
sphinx-autodoc-argparse = false
sphinx-autodoc-docutils = false
sphinx-autodoc-fastmcp = false
sphinx-autodoc-pytest-fixtures = false
sphinx-autodoc-sphinx = false
sphinx-autodoc-typehints-gp = false
sphinx-fonts = false
sphinx-gp-opengraph = false
sphinx-gp-llms = false
sphinx-gp-sitemap = false
sphinx-gp-theme = false
sphinx-ux-autodoc-layout = false
sphinx-ux-badges = false

[tool.mypy]
python_version = "3.10"
warn_unused_configs = true
files = [
  "src",
  "tests",
  "docs/_ext",
]
strict = true

[[tool.mypy.overrides]]
module = [
  "shtab",
  "pygments",
  "pygments.*",
]
ignore_missing_imports = true

[tool.coverage.run]
branch = true
parallel = true
omit = [
  "*/_*",
  "*/_compat.py",
  "docs/conf.py",
  "docs/_ext/*",
  "tests/*",
]

[tool.coverage.report]
show_missing = true
skip_covered = true
exclude_lines = [
  "pragma: no cover",
  "def __repr__",
  "raise NotImplementedError",
  "return NotImplemented",
  "def parse_args",
  "if TYPE_CHECKING:",
  "if t.TYPE_CHECKING:",
  "@overload( |$)",
  "from __future__ import annotations",
]

[tool.ruff]
target-version = "py310"

[tool.ruff.lint]
# `select` is deliberately unset: ruff 0.16 enables a curated default rule
# set, and an explicit `select` would replace it rather than extend it.
# `extend-select` layers this project's additional linters on top.
extend-select = [
  "E", # pycodestyle
  "F", # pyflakes
  "I", # isort
  "UP", # pyupgrade
  "A", # flake8-builtins
  "B", # flake8-bugbear
  "C4", # flake8-comprehensions
  "COM", # flake8-commas
  "EM", # flake8-errmsg
  "Q", # flake8-quotes
  "PTH", # flake8-use-pathlib
  "SIM", # flake8-simplify
  "TRY", # Trycertatops
  "PERF", # Perflint
  "RUF", # Ruff-specific rules
  "D", # pydocstyle
  "FA100", # future annotations
]
ignore = [
  "COM812", # missing trailing comma, ruff format conflict
]
extend-safe-fixes = [
  "UP006",
  "UP007",
]
pyupgrade.keep-runtime-typing = false

[tool.ruff.lint.flake8-builtins]
builtins-allowed-modules = [
  "dataclasses",
  "types",
]

[tool.ruff.lint.pydocstyle]
convention = "numpy"

[tool.ruff.lint.isort]
known-first-party = [
  "vcspull",
]
combine-as-imports = true
required-imports = [
  "from __future__ import annotations",
]

[tool.ruff.lint.per-file-ignores]
"*/__init__.py" = ["F401"]
# Sphinx conf.py reads the package's version metadata by exec'ing
# src/vcspull/__about__.py, so conf.py stays importable without the
# package installed. The input is a file in this repository.
"docs/conf.py" = ["S102"]
# The smoke test's job is to report any failure from importing an
# arbitrary module or invoking the CLI, so the catch has to be as wide
# as the failures it is probing for.
"scripts/runtime_dep_smoketest.py" = ["BLE001"]
# atexit handlers that raise are swallowed by the interpreter, so the
# cursor-restore handler logs and swallows to leave a breadcrumb
# without masking other shutdown tasks.
"src/vcspull/cli/_progress.py" = ["BLE001"]
# The sync worker thread catches everything, including BaseException,
# to hand the failure back to the main thread; narrowing would lose
# the exception instead of reporting it.
"src/vcspull/cli/sync.py" = ["BLE001"]
# A log formatter that raises takes the application down with it, so
# %-format failures in a caller's record become a "Bad message" line
# rather than an exception.
"src/vcspull/log.py" = ["BLE001"]

[tool.pytest.ini_options]
addopts = "--tb=short --no-header --showlocals --doctest-modules"
doctest_optionflags = "ELLIPSIS NORMALIZE_WHITESPACE"
asyncio_mode = "auto"
asyncio_default_fixture_loop_scope = "function"
testpaths = [
  "src/vcspull",
  "tests",
  "docs/_ext",
  "scripts",
]
markers = [
  "scripts__runtime_dep_smoketest: run runtime dependency smoke tests",
]
filterwarnings = [
  "ignore:The frontend.Option(Parser)? class.*:DeprecationWarning::",
]