jk-version


Namejk-version JSON
Version 0.2021.4.14 PyPI version JSON
download
home_page
SummaryThis python module provides a version class. Instances of this class may be used in representing and version numbers and compare them.
upload_time2021-04-14 15:59:41
maintainer
docs_urlNone
authorJürgen Knauth
requires_python
licenseApache2
keywords version versioning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            jk_version
==========

Introduction
------------

This python module provides a version class. Instances of this class may be used in representing and version numbers and compare them.

Information about this module can be found here:

* [github.org](https://github.com/jkpubsrc/python-module-jk-version)
* [pypi.python.org](https://pypi.python.org/pypi/jk_version)

Why this module?
----------------

...

Limitations of this module
--------------------------

...

How to use this module
----------------------

### Import this module

Please include this module into your application using the following code:

```python
import jk_version
```

### Parse a version number

Version numbers can either be specified as lists of integers or as a string. Examples:

* `Version([ 1, 7, 51 ])`
* `Version(( 1, 7, 51 ))`
* `Version("1.7.51")`

### Version numbering schema

For compatibility reasons the version number parser is designed to accept the following schema:

*[ epoch ":" ] version_data*

Where *epoch* is optional and - if present - must be an integer, and *version_data* is a regular version string consisting of decimal numbers separated by full stops.

Examples for valid version numbers:

* `0`
* `0.1`
* `0.1.2`
* `2020.12.24`
* `2:0.1.2`

### Comparing version numbers

Version numbers can be compared. Example:

```python
v1 = Version("0.1.2")
v2 = Version("0.2.0")
print(v2 > v1)
```

This will print: `True`

Contact Information
-------------------

This work is Open Source. This enables you to use this work for free.

Please have in mind this also enables you to contribute. We, the subspecies of software developers, can create great things. But the more collaborate, the more fantastic these things can become. Therefore Feel free to contact the author(s) listed below, either for giving feedback, providing comments, hints, indicate possible collaborations, ideas, improvements. Or maybe for "only" reporting some bugs:

* Jürgen Knauth: jknauth@uni-goettingen.de, pubsrc@binary-overflow.de

License
-------

This software is provided under the following license:

* Apache Software License 2.0
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "jk-version",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "version,versioning",
    "author": "J\u00fcrgen Knauth",
    "author_email": "pubsrc@binary-overflow.de",
    "download_url": "https://files.pythonhosted.org/packages/8c/07/a846ac7f83136efc2d190caa95904fab272aff841848b1d9ef6bf09c72e6/jk_version-0.2021.4.14.tar.gz",
    "platform": "",
    "description": "jk_version\n==========\n\nIntroduction\n------------\n\nThis python module provides a version class. Instances of this class may be used in representing and version numbers and compare them.\n\nInformation about this module can be found here:\n\n* [github.org](https://github.com/jkpubsrc/python-module-jk-version)\n* [pypi.python.org](https://pypi.python.org/pypi/jk_version)\n\nWhy this module?\n----------------\n\n...\n\nLimitations of this module\n--------------------------\n\n...\n\nHow to use this module\n----------------------\n\n### Import this module\n\nPlease include this module into your application using the following code:\n\n```python\nimport jk_version\n```\n\n### Parse a version number\n\nVersion numbers can either be specified as lists of integers or as a string. Examples:\n\n* `Version([ 1, 7, 51 ])`\n* `Version(( 1, 7, 51 ))`\n* `Version(\"1.7.51\")`\n\n### Version numbering schema\n\nFor compatibility reasons the version number parser is designed to accept the following schema:\n\n*[ epoch \":\" ] version_data*\n\nWhere *epoch* is optional and - if present - must be an integer, and *version_data* is a regular version string consisting of decimal numbers separated by full stops.\n\nExamples for valid version numbers:\n\n* `0`\n* `0.1`\n* `0.1.2`\n* `2020.12.24`\n* `2:0.1.2`\n\n### Comparing version numbers\n\nVersion numbers can be compared. Example:\n\n```python\nv1 = Version(\"0.1.2\")\nv2 = Version(\"0.2.0\")\nprint(v2 > v1)\n```\n\nThis will print: `True`\n\nContact Information\n-------------------\n\nThis work is Open Source. This enables you to use this work for free.\n\nPlease have in mind this also enables you to contribute. We, the subspecies of software developers, can create great things. But the more collaborate, the more fantastic these things can become. Therefore Feel free to contact the author(s) listed below, either for giving feedback, providing comments, hints, indicate possible collaborations, ideas, improvements. Or maybe for \"only\" reporting some bugs:\n\n* J\u00fcrgen Knauth: jknauth@uni-goettingen.de, pubsrc@binary-overflow.de\n\nLicense\n-------\n\nThis software is provided under the following license:\n\n* Apache Software License 2.0",
    "bugtrack_url": null,
    "license": "Apache2",
    "summary": "This python module provides a version class. Instances of this class may be used in representing and version numbers and compare them.",
    "version": "0.2021.4.14",
    "split_keywords": [
        "version",
        "versioning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7ff9c1c834f000d797d86c657b247cb8",
                "sha256": "542039697eee22deff1247b49cc41a3d749d7883dfc9f203e4b3e56eda1a09be"
            },
            "downloads": -1,
            "filename": "jk_version-0.2021.4.14.tar.gz",
            "has_sig": false,
            "md5_digest": "7ff9c1c834f000d797d86c657b247cb8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7726,
            "upload_time": "2021-04-14T15:59:41",
            "upload_time_iso_8601": "2021-04-14T15:59:41.966782Z",
            "url": "https://files.pythonhosted.org/packages/8c/07/a846ac7f83136efc2d190caa95904fab272aff841848b1d9ef6bf09c72e6/jk_version-0.2021.4.14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-14 15:59:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "jk-version"
}
        
Elapsed time: 0.21318s