Metadata-Version: 2.1
Name: semmy
Version: 0.4.0
Summary: Semantic versioning made easy for Python
Home-page: https://pypi.org/project/semmy/
License: MIT
Author: Niko Heikkilä
Author-email: yo@nikoheikkila.fi
Requires-Python: >=3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Project-URL: Bug Tracker, https://github.com/nikoheikkila/semmy/issues
Project-URL: Documentation, https://github.com/nikoheikkila/semmy/blob/main/README.md
Project-URL: Discussions, https://github.com/nikoheikkila/semmy/discussions
Project-URL: Repository, https://github.com/nikoheikkila/semmy
Description-Content-Type: text/markdown

<h1>Semmy</h1>

> Semantic versioning made easy for Python

* [Features](#features)
* [API](#api)
* [Prerequisites](#prerequisites)
* [Install](#install)
* [Contributing](#contributing)

## Features

* Parses semantic version domain objects from valid strings
* Check if two versions are equal
* Check if version is a pre-release
* Bump (pre-)major, (pre-)minor, and (pre-)patch versions
* Check if version is greater (newer) or lesser (older) than other version (upcoming)

## API

To be written.

Check [unit tests](tests/test_semmy.py) for complete examples.

## Prerequisites

* **Python** >=3.8 or later

## Install

```sh
poetry add semmy
```

Alternatively, for older projects.

```sh
pip install semmy
pip freeze > requirements.txt
```

## Contributing

See [**here**](CONTRIBUTING.md) for instructions.

