Metadata-Version: 2.1
Name: setuptools_scm_git_semver
Version: 0.2.0
Summary: SemVer-compatible plugin for setuptools_scm.
Home-page: https://github.com/cloudreach/setuptools_scm_git_semver
Author: Cloudreach Software Team Ops Management
Author-email: sw-team-ops-management@cloudreach.com
License: MIT
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# `setuptools_scm_git_semver`

[SemVer]-compatible hooks for [`setuptools_scm`].

This package was created because `setuptools_scm` produces [PEP 440] compliant version numbers,
which are not always compatible with SemVer.

## Usage

Usage is no different from normal setuptools_scm -- this package just adds 1
version scheme and local scheme each:

- `guess-next-rc`: Returns the next version as RC when not on a clean tag

- `time-dot-node`: Returns a local version of +<time>.<node>

Example configurations to get version numbers that are both valid python
package versions and SemVer versions:

Using pyproject.toml:

```toml
[build-system]
requires = [
    "setuptools",
    "setuptools_scm",
    "setuptools_scm_git_semver",
]
build-backend = 'setuptools.build_meta'

[tool.setuptools_scm]
version_scheme = "guess-next-rc"
local_scheme = "time-dot-node"
normalize = false
```

## Releases

The package should be released to PyPI. The first release will be performed manually, and CI will be
written later.


[SemVer]: https://semver.org
[`setuptools_scm`]: https://github.com/pypa/setuptools_scm
[PEP 440]: https://www.python.org/dev/peps/pep-0440/#version-scheme


