pyproject.toml

[project]

name = "custy"

dynamic = ["version"]
# version = "2.1.2"
# With this the version will be auto-generated from git tags using setuptools_scm
# When run
# pip install
# or
# python -m build
# it will extract the version from Git tag and use it automatically.
#
# To use the auto version inside code:
# ```python
# from importlib.metadata import version
# __version__ = version("currency-conversion-api")
# ✅ This will always return the version from Git tag if setuptools_scm is used properly.


description = "Configuration-driven developer CLI for project initialization, validation, versioning, changelog generation, Git release automation, reusable pipelines, backups, cleanup, and multi-remote synchronization."

readme = "README.md"

requires-python = ">=3.14"

license = { text = "MIT" }

authors = [
    { name = "Rizky Fernandes (devalltect00)", email = "devalltect00@gmail.com"},
]

maintainers = [
    { name = "Rizky Fernandes (devalltect00)", email = "devalltect00@gmail.com"},
]

keywords = [
    "git",
    "git-workflow",
    "git-automation",
    "git-tagging",
    "release-automation",
    "release-management",
    "versioning",
    "version-bump",
    "conventional-commits",
    "semantic-versioning",
    "pep440",
    "semver",
    "commitizen",
    "changelog",
    "changelog-generator",
    "project-initialization",
    "project-validation",
    "automation",
    "developer-tools",
    "devops",
    "cli",
    "cli-tool",
    "typer",
    "rich",
    "release-pipeline",
    "dry-run",
    "github",
    "gitlab",
    "docker",
    "multi-remote",
]

classifiers = [
    "Development Status :: 5 - Production/Stable",

    "Intended Audience :: Developers",
    "Intended Audience :: System Administrators",

    "License :: OSI Approved :: MIT License",

    "Operating System :: OS Independent",

    "Environment :: Console",

    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.14",

    "Topic :: Software Development",
    "Topic :: Software Development :: Build Tools",
    "Topic :: Software Development :: Version Control",
    "Topic :: System :: Software Distribution",
    "Topic :: Utilities",
]

dependencies = [
    # CLI Framework
    "typer>=0.16.0",

    # Terminal UI
    "rich>=14.1.0",
    "pyfiglet>=1.0.4",
    "termcolor>=3.1.0",
    "colorama>=0.4.6",

    # Templates
    "jinja2>=3.1.6",

    # Configuration
    "toml>=0.10.2",
    "tomlkit>=0.15.0",

    # Data Validation
    "pydantic>=2.11.7",

    # Version Parsing / PEP 440
    "packaging>=25.0",
]

[project.optional-dependencies]

commitizen = [
    # Optional commit-message validation and version strategy integration
    "commitizen>=4.0.0",
]

hooks = [
    # Optional direct execution for cross-platform pre-commit wrappers
    "pre-commit>=3.7.0",
]

dev = [
    # Test
    "pytest>=8.0.0",
    "pytest-cov>=5.0.0",

    # Formatting
    "black==26.5.1",

    # Linting
    "ruff==0.16.5",

    # Packaging
    "build>=1.2.0",
    "packaging>=24.0",
    "twine>=5.0.0",

    # Git hooks
    "pre-commit>=3.7.0",

    # related to `AREPL for python` vscode extensions
    "ipykernel",

    # Commitizen
    "commitizen>=4.0.0",
]

docs = [
    "mkdocs>=1.6.0",
    "mkdocs-material>=9.5.0",
]

[project.urls]

Homepage = "https://github.com/devalltect00/Custy"
Repository = "https://github.com/devalltect00/Custy"
Issues = "https://github.com/devalltect00/Custy/issues"
Documentation = "https://devalltect00.github.io/devalltect-docs/docs/custy"
Changelog = "https://github.com/devalltect00/Custy/blob/main/CHANGELOG.md"
Discussions = "https://github.com/devalltect00/Custy/discussions"
Releases = "https://github.com/devalltect00/Custy/releases"
"GitHub Actions" = "https://github.com/devalltect00/Custy/actions"
"GitLab CI" = "https://gitlab.com/devalltects-group/Custy/-/pipelines"
"Container Images" = "https://github.com/devalltect00/Custy/pkgs/container/custy"

[tool.devalltect.github]

# Curated GitHub repository topics are maintained separately from the broader
# Python package-discovery keywords under [project]. This table stores desired
# metadata only; applying it to GitHub requires an explicit synchronization.
topics = [
    "custy",
    "git",
    "git-automation",
    "release-automation",
    "release-management",
    "versioning",
    "semantic-versioning",
    "pep440",
    "changelog",
    "changelog-generator",
    "conventional-commits",
    "project-initialization",
    "project-validation",
    "release-pipeline",
    "multi-remote",
    "dry-run",
    "developer-tools",
    "cli",
    "python",
    "devops",
]

[tool.devalltect.gitlab]

# Curated GitLab project topics are maintained separately from GitHub topics
# and the broader Python package-discovery keywords under [project]. This table
# stores desired metadata only; applying it to GitLab requires explicit
# synchronization. Do not include credentials or other sensitive information.
topics = [
    "custy",
    "git",
    "git-automation",
    "release-automation",
    "release-management",
    "versioning",
    "semantic-versioning",
    "pep440",
    "changelog",
    "changelog-generator",
    "conventional-commits",
    "project-initialization",
    "project-validation",
    "release-pipeline",
    "multi-remote",
    "dry-run",
    "developer-tools",
    "cli",
    "python",
    "devops",
]

[project.scripts]

custy = "app.__main__:main"
git-credential-custy = "app.core.git_ops.credentials.helper:main"

# =========================================================
# TYPER
# =========================================================

[tool.typer]

pretty_exceptions_enable = true

# =========================================================
# SETUPTOOLS
# =========================================================

[tool.setuptools.packages.find]

include = [
    "app*",
]

exclude = ["venv*"]

#####
# NOTE:
# Need this.
#
# Without it:
# - importlib.resources will FAIL ❌
# - your templates won’t exist after pip install ❌
# - your tool breaks outside dev ❌
#####
# It tells Python’s build system:
#
# “When someone installs my package, also include these non-Python files (templates).”
#####
[tool.setuptools.package-data]

app = [
    "templates/**/*",
    "templates/*.toml",
    "templates/**/*.toml",
    "templates/*.py",
    "templates/**/*.py",
    "templates/*.txt",
    "templates/**/*.txt",
    "templates/*.md",
    "templates/**/*.md",
    "templates/changelog/*.j2",
    "templates/changelog/**/*.j2",
    "templates/examples/*.md",
    "templates/examples/**/*.md",
    # "**/*",
]

# =========================================================
# SETUPTOOLS_SCM
# =========================================================

[tool.setuptools_scm]
version_scheme = "guess-next-dev"
local_scheme = "no-local-version"

fallback_version = "2.1.2"

# =========================================================
# PYTEST
# =========================================================

[tool.pytest.ini_options]

testpaths = [
    "tests",
]

python_files = [
    "test_*.py",
]

python_classes = [
    "Test*",
]

python_functions = [
    "test_*",
]

addopts = [
    # -----------------------------------------------------
    # Summary
    # -----------------------------------------------------

    "-ra",                          # Show extra test summary info for skipped, failed, xfailed, etc.

    # -----------------------------------------------------
    # Validation
    # -----------------------------------------------------

    "--strict-markers",             # Fail on unknown pytest markers.
    "--strict-config",              # Fail on invalid or unknown pytest configuration.

    # -----------------------------------------------------
    # Output
    # -----------------------------------------------------

    "--tb=short",                   # Use shorter traceback output.

    # -----------------------------------------------------
    # COVERAGE
    # -----------------------------------------------------

    "--cov=app",                    # Enable coverage. Measure test coverage for the app package.
    "--cov-report=term-missing",    # Shows missing lines directly in terminal output.

    # -----------------------------------------------------
    # IMPORTS
    # -----------------------------------------------------

    "--import-mode=importlib",      # Fixes import conflicts with same-named test files
]

filterwarnings = [
    "ignore::DeprecationWarning",
]

# =========================================================
# BLACK
# =========================================================

[tool.black]

line-length = 88
target-version = ["py314"]

# Preserve inactive migration/reference files even when paths are supplied
# explicitly by pre-commit, an editor, or a developer command.
force-exclude = '''
(
    /dev_venv/
  | /prod_venv/
  | /venv_dev/
  | /venv_prod/
  | /publish_venv/
  | /venv_publish/
  | /other_venv/
  | /venv_other/
  | /old/
  | /example_before/
  | \.deprecated\.py$
  | \.old[^/]*\.py$
  | \.dev\.py$
  | [ _]copy\.py$
  | _temp\.py$
  | _temp_before\.py$
)
'''

# =========================================================
# RUFF
# =========================================================

[tool.ruff]

line-length = 88
target-version = "py314"

# Respect `exclude` even when pre-commit or another caller supplies file paths
# explicitly instead of relying on Ruff's recursive file discovery.
force-exclude = true

exclude = [
    ".git",
    ".venv",
    "venv",
    "dev_venv",
    "prod_venv",
    "venv_dev",
    "venv_prod",
    "publish_venv",
    "venv_publish",
    "other_venv",
    "venv_other",
    "__pycache__",
    "build",
    "dist",
    "**/old/**",
    "**/example_before/**",
    "**/*.deprecated.py",
    "**/*.old*.py",
    "**/*.dev.py",
    "**/* copy.py",
    "**/*_copy.py",
    "**/*_temp.py",
    "**/*_temp_before.py",
]

# =========================================================
# RUFF LINT
# =========================================================

[tool.ruff.lint]

select = [
    "E",   # pycodestyle errors
    "W",   # pycodestyle Warnings
    "F",   # pyflakes
    "I",   # isort
    "UP",  # pyupgrade
    "B",   # flake8-bugbear
]

ignore = [
    "E501",    # Line too long
    "INP001",  # Implicit namespace package
    "T201",    # print() found
    "UP045",    # pyupgrade. Ignore checking for example: 'Optional[str]' -> 'str | None'
    "UP042",     # pyupgrade StrEnum suggestion
]

[tool.ruff.lint.isort]

# Custy is imported as the top-level ``app`` package. Declaring it explicitly
# keeps local, pre-commit, and hosted CI import grouping deterministic.
known-first-party = ["app"]

[tool.ruff.lint.per-file-ignores]

"app/cli/commands/**/*.py" = ["F403", "F405"]

# =========================================================
# RUFF FORMAT
# =========================================================
#
# Ruff formatter configuration.
#
# Ruff provides linting and optional formatting. Black remains supported,
# and both formatters share the same line-length and target-version policy.
#
# =========================================================

[tool.ruff.format]

# Normalize all strings to double quotes
quote-style = "double"

# Use spaces for indentation
indent-style = "space"

# Automatically detect line endings
# (LF on Linux/macOS, CRLF on Windows)
line-ending = "auto"

# Format Python examples embedded inside docstrings
docstring-code-format = true

# =========================================================
# BUILD SYSTEM
# =========================================================

[build-system]

requires = [
    "setuptools>=80",
    # "setuptools_scm[toml]>=8",
    "setuptools-scm>=8",
    "wheel",
]

build-backend = "setuptools.build_meta"

# =========================================================
# COVERAGE
# =========================================================

[tool.coverage.run]

source = ["app"]

[tool.coverage.report]

show_missing = true
skip_covered = false