semantic-version-tools 1.3.1__tar.gz → 1.3.3__tar.gz

semantic_version_tools-1.3.3/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: semantic-version-tools
+Version: 1.3.3
+Summary: Class to manage semantic versioning
+Author: Romolo Politi
+Author-email: romolo.politi@inaf.it
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: setuptools (>=80.9.0,<81.0.0)
+Description-Content-Type: text/markdown
+
+
+# Version-Tools
+
+## Installation
+
+### From Repository
+
+To install the Version-Tools package from the repository, run the following commands:
+
+```sh
+git clone https://github.com/RomoloPoliti-INAF/version-tools.git
+cd version-tools
+poetry install
+```
+
+### From PyPi
+
+To install the Version-Tools package from PyPi, run the following command:
+
+```sh
+pip install semantic-version-tools
+```
+### Using poetry
+
+To add the package to your poetry project, you can run the command:
+
+```sh
+poetry add semantic-versioning-tools
+```
+
+
+## Usage
+
+To use the library it's necessary import the class *Vers*, than you can comapare or manipulate the version numbers.
+
+### Initialize and print version
+
+```python
+>>> from semantic_version_tools import Vers
+
+>>> main_ver=Vers('1.0')
+>>> print(main_ver)
+
+Version 1.0
+```
+
+The version number could be a string or a tuple, whit 2 or 5 elements:
+- the major version number
+- the minor version number
+- the patch number
+- pre-release type
+- build number
+
+For the pre-release are used letters as reported below:
+
+- **d**: developing version
+- **a**: alpha release
+- **b**: beta release
+- **rc**: release candidate
+- **f**: final release
+
+```python
+>>> main_version = Vers((0,1,0,'d',1))
+>>> print(main_version)
+
+Version 0.1.0-devel.1
+
+>>> main_version = Vers('0.1.0-a.1')
+>>> print(main_version)
+
+Version 0.1.0-alpha.1
+```
+
+### Compare versions
+
+In the class Vers are implemented the main comparison operators.
+For example:
+
+```python
+>>> a=Vers('1.0.0')
+>>> b=Vers('1.0.1')
+
+>>> a>b
+False
+>>> a==b
+False
+>>> a<b
+True
+a<=b
+True
+```
+
+### Sum and increase
+
+It's possible sum tro version number or icrease it.
+
+```python
+>>> a = Vers('1.0.0')
+>>> b = Vers('1.0.1')
+>>> c=a+b
+>>> c
+Version 2.0.1
+
+
+>>> a = Vers('1.0.0')
+>>> a=a+1
+>>> a
+Version 1.1.0
+# equivalent to
+>>> a +=1
+>>> a
+Version 1.1.0
+```
+
+The summ add a minor version. To add a major version you must add a float
+
+```python
+>>> a = Vers('1.0.0')
+>>> a += 1.0
+>>> a
+Version 2.0.0
+```

semantic_version_tools-1.3.3/README.md

@@ -0,0 +1,122 @@
+
+# Version-Tools
+
+## Installation
+
+### From Repository
+
+To install the Version-Tools package from the repository, run the following commands:
+
+```sh
+git clone https://github.com/RomoloPoliti-INAF/version-tools.git
+cd version-tools
+poetry install
+```
+
+### From PyPi
+
+To install the Version-Tools package from PyPi, run the following command:
+
+```sh
+pip install semantic-version-tools
+```
+### Using poetry
+
+To add the package to your poetry project, you can run the command:
+
+```sh
+poetry add semantic-versioning-tools
+```
+
+
+## Usage
+
+To use the library it's necessary import the class *Vers*, than you can comapare or manipulate the version numbers.
+
+### Initialize and print version
+
+```python
+>>> from semantic_version_tools import Vers
+
+>>> main_ver=Vers('1.0')
+>>> print(main_ver)
+
+Version 1.0
+```
+
+The version number could be a string or a tuple, whit 2 or 5 elements:
+- the major version number
+- the minor version number
+- the patch number
+- pre-release type
+- build number
+
+For the pre-release are used letters as reported below:
+
+- **d**: developing version
+- **a**: alpha release
+- **b**: beta release
+- **rc**: release candidate
+- **f**: final release
+
+```python
+>>> main_version = Vers((0,1,0,'d',1))
+>>> print(main_version)
+
+Version 0.1.0-devel.1
+
+>>> main_version = Vers('0.1.0-a.1')
+>>> print(main_version)
+
+Version 0.1.0-alpha.1
+```
+
+### Compare versions
+
+In the class Vers are implemented the main comparison operators.
+For example:
+
+```python
+>>> a=Vers('1.0.0')
+>>> b=Vers('1.0.1')
+
+>>> a>b
+False
+>>> a==b
+False
+>>> a<b
+True
+a<=b
+True
+```
+
+### Sum and increase
+
+It's possible sum tro version number or icrease it.
+
+```python
+>>> a = Vers('1.0.0')
+>>> b = Vers('1.0.1')
+>>> c=a+b
+>>> c
+Version 2.0.1
+
+
+>>> a = Vers('1.0.0')
+>>> a=a+1
+>>> a
+Version 1.1.0
+# equivalent to
+>>> a +=1
+>>> a
+Version 1.1.0
+```
+
+The summ add a minor version. To add a major version you must add a float
+
+```python
+>>> a = Vers('1.0.0')
+>>> a += 1.0
+>>> a
+Version 2.0.0
+```

{semantic_version_tools-1.3.1 → semantic_version_tools-1.3.3}/pyproject.toml

@@ -1,28 +1,22 @@
 [project]
 name = "semantic-version-tools"
-version = "1.3.1"
+version = "1.3.3"
 description = "Class to manage semantic versioning"
 authors = [
     {name = "Romolo Politi",email = "romolo.politi@inaf.it"}
 ]
 readme = "README.md"
+
+
+requires-python = ">=3.10,<4.0"
 dependencies = [
-    "setuptools (>=75.8.0,<76.0.0)"
+    "setuptools (>=80.9.0,<81.0.0)"
 ]
 
 
 [tool.poetry]
 packages = [{include = "semantic_version_tools", from = "src"}]
-include = ["CHANGELOG.md"]
-name="semantic-version-tools"
-version="1.3.1"
-description="Class to manage semantic versioning"
-authors = [
-    "Romolo Politi <romolo.politi@inaf.it>"
-]
 
-[tool.poetry.dependencies]
-python = ">=3.10, <3.14"
 
 
 [tool.poetry.group.dev.dependencies]

semantic_version_tools-1.3.1/PKG-INFO

@@ -1,11 +0,0 @@
-Metadata-Version: 2.1
-Name: semantic-version-tools
-Version: 1.3.1
-Summary: Class to manage semantic versioning
-Author: Romolo Politi
-Author-email: romolo.politi@inaf.it
-Requires-Python: >=3.10,<3.14
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12