Skip to main content
https://img.shields.io/pypi/v/jaraco.vcs.svg https://img.shields.io/pypi/pyversions/jaraco.vcs.svg tests Ruff https://img.shields.io/badge/skeleton-2025-informational

Usage

jaraco.vcs provides classes for inspecting and working with repositories in the Mercurial and Git version control systems (VCS).

The classes provided are designed to use subprocess invocation to leverage the command-line interfaces of the VCS tools hg and git. An in-process Repo for Mercurial exists but has been disabled due to issues that arise when run in certain environments (namely setuptools sandboxing).

Auto Version Numbering

This project adds support for automatically generating project version numbers from a source code repository under development.

To use this feature, the project must follow the following assumptions:

  • Repo tags are used to indicate released versions.

  • Tag names are specified as the version only (i.e. 0.1 or v0.1 and not release-0.1)

  • Released versions currently must conform to the Version in packaging. Any tags that don’t match this scheme will be ignored.

Thereafter, use the Repo.get_current_version to determine the version of the local code. If the current revision is tagged with a valid version, that version will be used. Otherwise, the tags in the repo will be searched, the latest release will be found, and the function will infer the upcoming release version.

For example, if the repo contains the tags 0.1, 0.2, and 0.3 and the repo is not on any of those tags, get_current_version will return ‘0.3.1dev’ and get_current_version(increment=’0.1’) will return ‘0.4dev’.

Example:

>>> import jaraco.vcs
>>> jaraco.vcs.repo().get_current_version()
'9.0.1.dev0'

Metadata

Release files for jaraco.vcs 2.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jaraco.vcs 2.4.1
File Size Uploaded
jaraco_vcs-2.4.1.tar.gz 18.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jaraco.vcs 2.4.1
File Interpreter ABI Platform
jaraco_vcs-2.4.1-py3-none-any.whl Python 3 none any Details

Total release size: 28.9 kB

Release files / jaraco_vcs-2.4.1.tar.gz

Download URL jaraco_vcs-2.4.1.tar.gz
Size 18.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1b3b1a4a9bebe14c0bba1ff17f30e01b4eacc3d64724fad6b51a3ee657fc4de5
BLAKE2b-256 checksum
How to use checksums
896e1c98078a579cebf5ad62f3ac721044886b1a1bac14273ca4e6df6f21bf00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.2

Release files / jaraco_vcs-2.4.1-py3-none-any.whl

Download URL jaraco_vcs-2.4.1-py3-none-any.whl
Size 10.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f29e9445c506c6559ed58ae1e5dab7a2f3132c905acaf3dfcce9e0f3de1a8391
BLAKE2b-256 checksum
How to use checksums
1054b48d43fbd3041249108dccfa539bc358803528166c5141eba0f99ae4b2ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.2

Release history Release notifications | RSS feed

This release

2.4.1 This release

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page