setuptools-scm API reference

63 public APIs from setuptools-scm (pypa/setuptools-scm) — 22 classes, 30 functions, 11 methods. Signatures extracted by static analysis of the actual source.

Repository: pypa/setuptools-scm

Kind	Count
Classes	22
Functions	30
Methods	11

API list

funcsetuptools-scm.check_api.main() -> int

Run griffe API check with proper configuration.

classsetuptools-scm.src.setuptools_scm._integration.build_py.build_py

Default build_py with version file writing.

classsetuptools-scm.src.setuptools_scm._integration.egg_info.ScmEggInfoMixin

Mixin for the ``egg_info`` command.

func

setuptools-scm.src.setuptools_scm._integration.setup_cfg.read_setup_cfg(input:str | os.PathLike[str]='setup.cfg') -> SetuptoolsBasicData

Parse setup.cfg and return unified data.

func

setuptools-scm.src.setuptools_scm._integration.setuptools.get_keyword_overrides(value:bool | dict[str, Any] | Callable[[], dict[str, Any]]) -> dict[str, Any]

normalize the version keyword input

classsetuptools-scm.src.setuptools_scm._integration.version_inference.VersionInferenceConfig

Configuration for version inference.

methodsetuptools-scm.src.setuptools_scm._integration.version_inference.VersionInferenceConfig.apply(dist:Distribution) -> None

Apply version inference to the distribution.

classsetuptools-scm.src.setuptools_scm._integration.version_inference.VersionInferenceNoOp

No operation result - silent skip.

methodsetuptools-scm.src.setuptools_scm._integration.version_inference.VersionInferenceNoOp.apply(dist:Distribution) -> None

Apply no-op to the distribution.

func

src.vcs_versioning_workspace.create_release_proposal.check_existing_pr(repo:Repository, source_branch:str) -> tuple[str, int | None]

Check for existing release PR.

funcsrc.vcs_versioning_workspace.create_release_proposal.find_fragments(project_dir:Path) -> list[Path]

Find changelog fragments in a project directory.

func

src.vcs_versioning_workspace.create_release_proposal.run_towncrier(project_dir:Path, version:str, *draft:bool=False) -> bool

Run towncrier build for a project.

func

vcs-versioning.src.vcs_versioning._backends._discover_vcs.discover(path:Path, *config:Configuration) -> ScmWorkdir | None

Probe *path* for jj, git, hg, or hg-git markers.

classvcs-versioning.src.vcs_versioning._backends._git.GitPreParse

Available git pre-parse functions

classvcs-versioning.src.vcs_versioning._backends._git.GitWorkdir

experimental, may change at any time

methodvcs-versioning.src.vcs_versioning._backends._git.GitWorkdir.list_tracked_files(path:Path | str='') -> list[str]

List files tracked by git, honoring export-ignore.

funcvcs-versioning.src.vcs_versioning._backends._git.fail_on_shallow(wd:GitWorkdir) -> None

experimental, may change at any time

funcvcs-versioning.src.vcs_versioning._backends._git.fetch_on_shallow(wd:GitWorkdir) -> None

experimental, may change at any time

func

vcs-versioning.src.vcs_versioning._backends._git.get_working_directory(config:Configuration, root:_t.PathT) -> GitWorkdir | None

Return the working directory (``GitWorkdir``).

funcvcs-versioning.src.vcs_versioning._backends._git.warn_on_shallow(wd:GitWorkdir) -> None

experimental, may change at any time

classvcs-versioning.src.vcs_versioning._backends._jj.JjWorkdir

Work directory backed by Jujutsu (jj).

func

vcs-versioning.src.vcs_versioning._backends._jj.get_working_directory(config:Configuration, root:_t.PathT) -> JjWorkdir | None

Return the working directory (``JjWorkdir``).

funcvcs-versioning.src.vcs_versioning._backends._jj.parse(root:_t.PathT, config:Configuration) -> ScmVersion | None

Parse version from a Jujutsu repository.

classvcs-versioning.src.vcs_versioning._backends._scm_workdir.ScmWorkdir

Base class for VCS work directories.

classvcs-versioning.src.vcs_versioning._cli._args.CliNamespace

Typed namespace for CLI arguments.

funcvcs-versioning.src.vcs_versioning._compat.entry_points(**params:str) -> list[EntryPoint]

Backport of entry_points(group=...) for Python 3.8/3.9.

funcvcs-versioning.src.vcs_versioning._compat.norm_real(path:PathT) -> str

Normalize and resolve a path (combining normcase and realpath).

funcvcs-versioning.src.vcs_versioning._compat.normalize_path_for_assertion(path:str) -> str

Normalize path separators for cross-platform assertions.

classvcs-versioning.src.vcs_versioning._config.Configuration

Global configuration model

classvcs-versioning.src.vcs_versioning._config.GitConfiguration

Git-specific configuration options

classvcs-versioning.src.vcs_versioning._config.ScmConfiguration

SCM-specific configuration options

methodvcs-versioning.src.vcs_versioning._config.ScmConfiguration.from_data(data:dict[str, Any] | None) -> ScmConfiguration

Create ScmConfiguration from configuration data

classvcs-versioning.src.vcs_versioning._config.TagConfiguration

Tag matching configuration options.

methodvcs-versioning.src.vcs_versioning._config.TagConfiguration.from_data(data:dict[str, Any] | None) -> TagConfiguration

Create TagConfiguration from configuration data.

funcvcs-versioning.src.vcs_versioning._discover.match_entrypoint(root:_t.PathT, name:str) -> bool

Consider a ``root`` as entry-point.

func

vcs-versioning.src.vcs_versioning._discover.walk_potential_roots(root:_t.PathT, search_parents:bool=True) -> Iterator[Path]

Iterate though a path and each of its parents.

classvcs-versioning.src.vcs_versioning._dump_version.DummyScmVersion

Placeholder for when no ScmVersion is available.

funcvcs-versioning.src.vcs_versioning._file_finders._git.git_find_files(path:_t.PathT='') -> list[str]

Find files tracked in a Git repository

funcvcs-versioning.src.vcs_versioning._file_finders._hg.hg_find_files(path:str='') -> list[str]

Find files tracked in a Mercurial repository

funcvcs-versioning.src.vcs_versioning._file_finders._jj.jj_find_files(path:_t.PathT='') -> list[str]

Find files tracked in a Jujutsu repository.

funcvcs-versioning.src.vcs_versioning._file_finders.find_files(path:_t.PathT='') -> list[str]

Discover files using registered file finder entry points.

funcvcs-versioning.src.vcs_versioning._get_version_impl.parse_version(config:Configuration) -> ScmVersion | None

Backward-compat shim for setuptools-scm <=10.0.x.

funcvcs-versioning.src.vcs_versioning._log.enable_debug(handler:logging.Handler | None=None) -> Iterator[None]

Enable debug logging for all SCM loggers.

classvcs-versioning.src.vcs_versioning._paths.ResolvedPaths

Canonical resolved paths for a Configuration.

func

vcs-versioning.src.vcs_versioning._paths.resolve_paths(*relative_to:_t.PathT | None, *root:_t.PathT='.', *project_path:str | None=None) -> ResolvedPaths

Compute canonical paths from config inputs.

classvcs-versioning.src.vcs_versioning._pyproject_reading.PyProjectData

Core pyproject.toml data structure

func

vcs-versioning.src.vcs_versioning._pyproject_reading.has_build_package(requires:Sequence[str], canonical_build_package_name:str) -> bool

Check if a package is in build requirements.

classvcs-versioning.src.vcs_versioning._scm_metadata.ScmVersionData

Serializable SCM version metadata.

funcvcs-versioning.src.vcs_versioning._scm_metadata.write_scm_file_list(target_dir:Path, files:list[str]) -> Path

Write ``scm_file_list.json`` into *target_dir*.

funcvcs-versioning.src.vcs_versioning._scm_metadata.write_scm_version_data(target_dir:Path, data:ScmVersionData) -> Path

Write ``scm_version.json`` into *target_dir*.

classvcs-versioning.src.vcs_versioning._scm_version.ScmVersion

represents a parsed version from scm

methodvcs-versioning.src.vcs_versioning._scm_version.ScmVersion.short_node() -> str | None

Return the node formatted for output.

classvcs-versioning.src.vcs_versioning._scm_version.VersionExpectations

Expected properties for ScmVersion matching.

classvcs-versioning.src.vcs_versioning._test_utils.WorkDir

a simple model for a

methodvcs-versioning.src.vcs_versioning._test_utils.WorkDir.create_basic_setup_cfg(name:str='test-package') -> None

Create a basic setup.cfg file with metadata.

methodvcs-versioning.src.vcs_versioning._test_utils.WorkDir.create_tag(tag:str='1.0.0') -> None

Create a tag using the configured tag_command.

method

vcs-versioning.src.vcs_versioning._test_utils.WorkDir.setup_git(monkeypatch:pytest.MonkeyPatch | None=None, *init:bool=True) -> WorkDir

Set up git SCM for this WorkDir.

methodvcs-versioning.src.vcs_versioning._test_utils.WorkDir.setup_hg(*init:bool=True) -> WorkDir

Set up mercurial SCM for this WorkDir.

methodvcs-versioning.src.vcs_versioning._test_utils.WorkDir.setup_jj(*init:bool=True) -> WorkDir

Set up Jujutsu (jj) SCM for this WorkDir.

classvcs-versioning.src.vcs_versioning._toml.InvalidTomlError

Raised when TOML data cannot be parsed.

classvcs-versioning.src.vcs_versioning._version_cls.NonNormalizedVersion

A non-normalizing version handler.

funcvcs-versioning.src.vcs_versioning._version_schemes.format_version(version:ScmVersion) -> str

Format a ScmVersion into a final version string.

funcvcs-versioning.src.vcs_versioning._worktree_discovery.discover_workdir(config:Configuration) -> AnyWorkdir | None

Discover the workdir for the given configuration.

About this data

These signatures were extracted from the public source of pypa/setuptools-scm using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries