Skip to main content

Versioning system with semantic versioning and generic version formats

Project description

Versioning Package

The versioning package is a fork from the version package which implements semantic versioning. The primary reason for forking version is to extend functionality to support a non-semantic versioning schema.

pip install enhanced-versioning==0.2.1

Semantic version implementation

The Enhanced-Versioning package provides SemanticVersion which implements versioning as described in Semantic Versioning spec 2.0.0-rc.1.

Example of simple X.Y.Z version:

>>> from enhanced_versioning import SemanticVersion

>>> v = SemanticVersion('1.2.3')

>>> v

>>> str(v)

>>> v.major

>>> v.minor

>>> v.patch

>>> v.pre_release


Example with pre-release and build versions:

>>> v2 = SemanticVersion('2.7.3-rc.2.15+19.e02afe3')

>>> v2.major

>>> v2.minor

>>> v2.patch

>>> v2.pre_release
['rc', 2, 15]

[19, 'e02afe3']

SemanticVersion supports rich comparison operators (<, <=, >, >=, ==, !=), and thus can be sorted:

>>> versions = [SemanticVersion('1.0.0+0.3.7'),
...             SemanticVersion('1.0.0'),
...             SemanticVersion('1.0.0-beta.11'),
...             SemanticVersion('0.9.0'),
...             SemanticVersion('1.0.0-rc.1'),
...             SemanticVersion('1.0.0-rc.1+build.1'),
...             SemanticVersion('1.0.0-alpha.1')]

>>> print('\n'.join(map(str, sorted(versions))))

Non-Semantic version implementation

The Versioning package provides NonSematicVersion which implements a non-semantic versioning system as described below.

Non-Semantic Versioning Specification

This specification carries over much of the Sematic Versioning Specification except as noted.

  1. Software using Non-Semantic Version MAY declare a public API, but it is not required.
  2. A version MUST consist of one or more dot separated revisions. A revision MUST contain at least one non-negative integer or ASCII alphabetical character [0-9A-Za-z] in which integers, if present, must precede characters. The revision is treated as two parts. The integer value and the character value where the integer value takes precedence over the character value in comparisons. Each revision much increase. For instance: 1.2a.4 -> 1.2b.4 -> 1.3a.4.
  3. See Semantic Versioning Specification Rule 3
  4. Non-Semantic Versioning does not define a standard for stability.
  5. Non-Semantic Versioning does not require a public API to be defined.
  6. Revisions to the left MUST carry greater weight than revisions to the right, but Non-Semantic Versioning does not define precisely what each revision must mean.
  7. Revisions to the right MUST be reset to the appropriate beginning value when revisions to the left are incremented. The integer value of a revision MUST be reset to 0. The character value SHOULD be reset to 'a'.
  8. See rule 7 above.
  9. See Semantic Versioning Specification Rule 9 regarding pre-releases.
  10. See Semantic Versioning Specification Rule 10 regarding builds.
  11. Precedence MUST be calculated by separating individual revisions and pre-release identifiers. Precedence is determined first by the number of revisions with more revisions taking precedence over fewer. If the number of revisions is equal, then precedence is determined by the first difference when comparing revisions from left to right where the integer values of the revisions are compared numerically first followed by the character values compared alphabetically. Example: 1 < 1.0 < 1.1a < 1.1e < 1.2a. When all revisions are equal, the precedence must be determined by pre-releases. See Semantic Versioning Specification Rule 11 for full details on pre-release precedence.

Example of non-semantic versioning:

>>> from enhanced_versioning import NonSemanticVersion

>>> v = NonSemanticVersion('1')

>>> v

>>> str(v)

>>> v.revisions

>>> v.pre_release


Example with pre-release and build versions:

>>> v2 = NonSemanticVersion('1.4f.2c-rc.2.15+19.e02afe3')

>>> v2

>>> str(v2)

>>> v2.revisions
['1', '4f', '2c']

>>> v2.pre_release
['rc', 2, 15]

[19, 'e02afe3']

NonSemanticVersion supports rich comparison operators (<, <=, >, >=, ==, !=), and thus can be sorted:

>>> versions = [NonSemanticVersion('1.0.4d.7f+0.3.7'),
...             NonSemanticVersion('1.0.4d.7f'),
...             NonSemanticVersion('1.0.4d.7f-beta.11'),
...             NonSemanticVersion('0.9.4d.7f'),
...             NonSemanticVersion('1.0.4d.7f-rc.1'),
...             NonSemanticVersion('1.0.4d.7f-rc.1+build.1'),
...             NonSemanticVersion('1.0.4d.7f-alpha.1'),
...             NonSemanticVersion('1.0.2f.12k+build.3')]

>>> print('\n'.join(map(str, sorted(versions))))

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

enhanced-versioning-0.3.0.tar.gz (10.5 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page