Metadata-Version: 2.1
Name: version-helper
Version: 0.1.0rc0
Summary: Helpers for a better version management in python projects
Home-page: https://github.com/dl6nm/version-helper
License: MIT
Keywords: git,describe,tags,version,__version__.py
Author: DL6NM
Author-email: mail@dl6nm.de
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: Software Development :: Version Control :: Git
Project-URL: Repository, https://github.com/dl6nm/version-helper
Description-Content-Type: text/markdown

# Version Helper

`version-helper` is a package for a better version management in python projects.

![License?][shield-license]

    from version_helper import Version

    # Parse output from `git describe --tag` and return a semantic versioning compatible `Version` object
    v = Version.get_from_git_describe()

    # Output core version string including major, minor and patch
    print(v.core)

    # Output full Semantic Version string including core, prerelease and build metadata
    print(v.full)

## Table of Contents

- [References](#references)

## Publish

    poetry publish --build [-r testpypi]

## References

- [git-describe](https://git-scm.com/docs/git-describe)
- [Poetry](https://python-poetry.org/)
- [Semantic Versioning](https://semver.org/)



[shield-license]: https://img.shields.io/badge/license-MIT-blue.svg "MIT License"

