Madonna¶

A Python semver parsing library.

Free software: MIT License
Documentation: https://FollowTheProcess.github.io/madonna/

Project Description¶

Madonna is a small, simple semver utility library with support for parsing, writing, and otherwise interacting with semantic versions in code.

Why the stupid name?

Get it? "Like a Version"... 👏🏻

Also naming things on PyPI is hard!

Installation¶

pip install madonna

Quickstart¶

The only construct in madonna is the Version object, you can use it for all sorts of useful things...

Create a New Version¶

from madonna import Version

v = Version(major=1, minor=2, patch=4)

Parse a Version from a string¶

from madonna import Version

Version.from_string("v1.2.4-rc.1+build.123")
# Version(major=1, minor=2, patch=4, prerelease="rc.1", buildmetadata="build.123")

Or JSON¶

from madonna import Version

Version.from_json('{"major": 1, "minor": 2, "patch": 4}')

And you can also dump a Version to a variety of formats too!

Contributing¶

madonna is an open source project and, as such, welcomes contributions of all kinds

Your best bet is to check out the contributing guide in the docs!

Credits¶

This package was created with cookiecutter and the FollowTheProcess/cookie_pypackage project template.