Skip to content

Commit

Permalink
feat: Add PIP package
Browse files Browse the repository at this point in the history
  • Loading branch information
panpuchkov committed Dec 27, 2023
1 parent aea4a46 commit 6caf5c7
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 7 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,24 @@ Features:

# Examples

You may use it as a Python package or a Docker container.

## PIP Package

```shell
$ git tag -l
v0.0.1
v0.0.2
$ python -m pygitver --curr-ver
v0.0.2
$ python -m pygitver --next-ver
v0.0.3

```


## Docker Container

```shell
$ git tag -l
v0.0.1
Expand Down Expand Up @@ -235,3 +253,15 @@ or
```shell
coverage run -m pytest -- ./tests/test_git.py
```
#### Build pip package
Linux
```shell
python3 -m build
```
For `Debian` based OS:
```shell
DEB_PYTHON_INSTALL_LAYOUT=deb_system python3 -m build
```
31 changes: 31 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[project]
name = "pygitver"
version = "0.0.1"
authors = [
{ name="Yurii Puchkov", email="[email protected]" },
]
description = "Manages Git Tag versions and generates ChangeLog"
keywords = ["git tag", "version", "versions", "conventional commit", "semver", "changelog", "changelogs"]
readme = "README.md"
requires-python = ">=3.8"
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Operating System :: OS Independent",
]
dependencies = [
"Jinja2==3.1.2"
]

[project.urls]
Homepage = "https://github.com/panpuchkov/pygitver"
Issues = "https://github.com/panpuchkov/pygitver/issues"

[build-system]
requires = ["setuptools", "wheel", "setuptools_scm[toml]>=6.2"]

[tool.setuptools_scm]

25 changes: 25 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[metadata]
name = "pygitver"
version = "0.0.1"
author="Yurii Puchkov"
author_email="[email protected]"

description = "Manages Git Tag versions and generates ChangeLog"
long_description = "README.md"
long_description_content_type = text/markdown
url = package url
project_urls =
Bug Tracker = package issues url
classifiers =
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GPLv3 License",
"Operating System :: OS Independent",

[options]
package_dir =
= src
packages = find:
python_requires = >=3.7

[options.packages.find]
where = src
7 changes: 0 additions & 7 deletions src/pygitver

This file was deleted.

0 comments on commit 6caf5c7

Please sign in to comment.