All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to PEP0440 styling guide. For full details, see the commit logs.
Click to open PEP0440 Styilng Guide
Packaging for PyPI follows the standard PEP0440 styling guide and is implemented by the packaging.version.Version class. The other
popular versioning scheme is semver, but each build has different parts/mapping.
The following table gives a mapping between these two versioning schemes:
PyPI Version |
semver Version |
|---|---|
epoch |
n/a |
major |
major |
minor |
minor |
micro |
patch |
pre |
prerelease |
dev |
build |
post |
n/a |
One can use the packaging version to convert between PyPI to semver and vice-versa. For more information, check
this link.
The release notes are documented, the list of changes to each different release are documented. The major.minor patch are indicated
under h3 tags, while the micro and "version identifiers" are listed under h4 and subsequent headlines. The legend for
changelogs are as follows:
- 🎉 - Major Feature : something big that was not available before.
- ✨ - Feature Enhancement : a miscellaneous minor improvement of an existing feature.
- 🛠️ - Patch/Fix : something that previously didn’t work as documented – or according to reasonable expectations – should now work.
- ⚙️ - Code Efficiency : an existing feature now may not require as much computation or memory.
- 💣 - Code Refactoring : a breakable change often associated with
majorversion bump.