Skip to main content

Facilities for working with VCS repositories

Project description

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-2024-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'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jaraco_vcs-2.3.1.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

jaraco.vcs-2.3.1-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file jaraco_vcs-2.3.1.tar.gz.

File metadata

  • Download URL: jaraco_vcs-2.3.1.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for jaraco_vcs-2.3.1.tar.gz
Algorithm Hash digest
SHA256 fe62c2bad9dbdb9a5c63c72d2f9148eec0a75e550fba6151eabf54c124ccbfc5
MD5 0f76adc0e266af40fac4e018c60b30f2
BLAKE2b-256 bf884b240e05335eb0e1c39d3b9103e6731e70931c839a8594eb5187d4ab0805

See more details on using hashes here.

Provenance

File details

Details for the file jaraco.vcs-2.3.1-py3-none-any.whl.

File metadata

  • Download URL: jaraco.vcs-2.3.1-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for jaraco.vcs-2.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 60acec768fdf668c217e8a41900ed152a3c893be7db10deee138dc96c4d35f6c
MD5 13fb7f63ed644e581dcb496ba066f858
BLAKE2b-256 b242a655f78b068de180f60eb0a917121b62d80c4e9dd2b9ef272f94ac6ee59b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page