Skip to main content

Get a descriptive version string in a git repository.

Project description

GitAutoVersion generates a version string for the current working directory in a git repository in the format:

<major>.<minor>.<patch>[.<misc>][-<prerelease>][+<upcount>][!<caveat>][#<metadata>]

Installation

Installation through the Python Package Index (PyPi) is recommended:

pip --install GitAutoVersion

Usage

This package provides the funtion getVersionString which returns the generated version string for the working direcory of the given repository. It requires a git repository object of the GitPython module as argument.

version = GitAutoVersion.getVersionString(git_repo)

You can modify the text for the special flags:

flag_development:str = "DEVELOPMENT"

Indicating that the version is in a development branch.

flag_git:str = "git"

Indicating that the metadata-chunk is a git Sha-1 hash

flag_branch:str = "branch"

How do you call a “branch”?

flag_dirty:str = "DIRTY"

What to say if the working directory is dirty

Caveats

This project is under development. It may break at any time.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

GitAutoVersion-0.0.12.dev0.tar.gz (4.3 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page