Metadata-Version: 2.1
Name: poetry-git-version-plugin
Version: 0.0.1
Summary: 
Author: irocshers
Author-email: develop.iam@rocshers.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: gitpython (>=3.1.29,<4.0.0)
Requires-Dist: pep440nz (>=0.5.2,<0.6.0)
Requires-Dist: poetry (>=1.2.0,<2.0.0)
Description-Content-Type: text/markdown

# Poetry Git Version Plugin

Descendant of `poetry-version-plugin`, which **does not work** on `poetry 1.2.0`.

## Functionality

- Project tag parsing
- Substitution of the project tag (if any) in the poetry.version value
- Maintenance of PEP 440

## Quick start

```bash
poetry self add poetry-git-version-plugin
poetry git-version # Write your git tag
```

## Dependencies

```toml
[tool.poetry.dependencies]
python = ">=3.10"
poetry = ">=1.2.0"
```

## Setup

```toml
[tool.poetry-git-version-plugin]
# Ignore "tag missing" errors
ignore_exception = true

# If the tag is missing.
# Returns a version, computed from the latest version tag.
# It takes the version tag, increases the version tag by the number of commits since, adds a local label specifying the git commit hash and the dirty status.
# Example: 1.3.2+5-5babef6
use_last_tag = true

# If the tag is missing.
# Returns the version computed from the last commit.
# It takes the template tag "0.0.1" and adds a local tag indicating the hash of the git commit.
#Example: 0.0.1+5babef6
use_dev_ref = true
```

## Contribute

Issue Tracker: <https://gitlab.com/rocshers/python/poetry-git-version-plugin/-/issues>
Source Code: <https://gitlab.com/rocshers/python/poetry-git-version-plugin>

