Metadata-Version: 2.1
Name: poem-plugins
Version: 0.14.0.dev0
Summary: Some set of poetry plugins
Home-page: https://pypi.org/project/poem-plugins
License: MIT
Keywords: plugins,poetry
Author: Ivan Sitkin
Author-email: alvinera@yandex.ru
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: poetry (>=1.2,<2.0)
Project-URL: Documentation, https://github.com/alviner/poem-plugins
Project-URL: Repository, https://github.com/alviner/poem-plugins
Description-Content-Type: text/markdown

# Poem Plugins

[![Pypi](https://img.shields.io/pypi/v/poem-plugins?color=%2334D058&label=pypi%20package)](https://pypi.org/project/poem-plugins)
[![Coverage Status](https://coveralls.io/repos/github/Alviner/poem-plugins/badge.svg?branch=main)](https://coveralls.io/github/Alviner/poem-plugins?branch=main)

A set of plugins for [**Poetry**](https://python-poetry.org/).

## How to use
Make sure you have Poetry version `1.2.0` or above. Read below for instructions to install it if you haven't.

### Install Poem Plugins

Install this plugin to your Poetry:

```console
$ poetry self add poem-plugins
```

Add tool section in project pyproject.toml

```toml
[tool.poem-plugins.version]
enabled = true
provider = "git"
# Create a file with version inside a project
write_version_file = true
# Save new version on pyproject
update_pyproject = true


[tool.poem-plugins.version.git]
# Version tags must be starts with this prefix
version_prefix = "v"
# Version format with commit hash (long) or not (short)
format = "short"
```

Create a git tag, for example:

```console
$ git tag v0.1
```

Next, build your project. It will show an output like:

```console
$ poetry build
poem-plugins: Setting version to: 0.1.0
Building awesome_package (0.1.0)
  - Building sdist
  - Built awesome_package-0.1.0.tar.gz
  - Building wheel
  - Built awesome_package-0.1.0-py3-none-any.whl```
```

