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 RepoManager 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 RepoManager.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.2.0.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

jaraco.vcs-2.2.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jaraco_vcs-2.2.0.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for jaraco_vcs-2.2.0.tar.gz
Algorithm Hash digest
SHA256 a245794d41e98680ed91d93a2af1d90e81e08a4e0856eb20f4c449c270e2a63a
MD5 1f09aa721a757e7c46d31226a2f735e3
BLAKE2b-256 ba84cfd4df2e19e80977adb83c226c8285cada0801c9ebac9e63c2f702542a8b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: jaraco.vcs-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for jaraco.vcs-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c1a7e2df6282357987df4509f645b1484106bde6626da0cada1b480c649d0947
MD5 b54d0b8c6dd82a1b2251acbdc068f2ed
BLAKE2b-256 5dbd8850348c8ae6146773602fff1c07c9fb169835235043e8db6edbb43a350f

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