setuptools-scm-git-archive

What it is and what it does

setuptools_scm_git_archive was a plugin for setuptools_scm that enabled version extraction from Git archives by reading metadata embedded in archive exports. It worked by parsing special Git export-ignore files to recover version information when the full Git history was not available—a common scenario in CI/CD pipelines and distributed builds.

The plugin is now obsolete. As of setuptools_scm version 7.0.0, this functionality has been integrated directly into setuptools_scm itself. The project repository is archived, the last commit was in February 2024, and no updates have been released since 2023-09-21. Users of older setuptools_scm versions who still rely on this plugin should migrate by updating their .git_archival.txt configuration file and upgrading to setuptools_scm >= 7.0.0.

Use it for:

• Extracting version info from Git archives in legacy CI/CD pipelines still using setuptools_scm < 7.0.0
• Maintaining compatibility with older projects that explicitly depend on this plugin
• Understanding how Git archive versioning worked before it was built into setuptools_scm

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A setuptools_scm plugin that extracts version information from Git archives—now obsolete, as setuptools_scm >= 7.0.0 includes this functionality natively.

No. Do not install this package. It is abandoned and obsolete—setuptools_scm >= 7.0.0 includes its functionality natively. If you are using an older setuptools_scm version, upgrade instead of adding this plugin. If you maintain a legacy project that currently depends on it, follow the migration guide in the package description to remove the dependency.

Install

setuptools-scm-git-archive on PyPI

pip install setuptools-scm-git-archive

uv add setuptools-scm-git-archive

poetry add setuptools-scm-git-archive

Installing setuptools-scm-git-archive

Before you install

The package is abandoned (last commit 2024-02-02, repository archived) and has not been updated since its latest release on 2023-09-21. Its functionality is now built into setuptools_scm >= 7.0.0, making this plugin unnecessary for new projects.

License in practice

Licensed under MIT (permissive), so there are no licensing restrictions on use or redistribution—but the package's obsolescence makes this moot.

Quickstart

# This package is obsolete. Instead, update .git_archival.txt in your repo to:
# node: $Format:%H$
# node-date: $Format:%cI$
# describe-name: $Format:%(describe:tags=true)$
# ref-names: $Format:%D$
# Then remove setuptools_scm_git_archive from your dependencies.

This plugin requires setuptools_scm to be installed; however, setuptools_scm >= 7.0.0 makes this plugin redundant.

Verify before relying

• Whether any active projects still depend on this plugin or if all users have migrated to setuptools_scm >= 7.0.0

Package facts

Evidence: setuptools_scm_git_archive-1.4.1-py2.py3-none-any.whl

Keywords: scm, vcs, version, tags, git, archive

Tags

More Build Tools packages