semantic-version-tools 1.3.0__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.0 → semantic_version_tools-1.3.3}/pyproject.toml

@@ -1,20 +1,22 @@
 [project]
 name = "semantic-version-tools"
-version = "1.3.0"
-description = ""
+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, <3.14"
+
+
+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 = "version_tools", from = "src"}]
-include = ["CHANGELOG.md"]
+packages = [{include = "semantic_version_tools", from = "src"}]
+
 
 
 [tool.poetry.group.dev.dependencies]

semantic_version_tools-1.3.3/src/semantic_version_tools/__init__.py

@@ -0,0 +1 @@
+from semantic_version_tools.version import Vers

{semantic_version_tools-1.3.0/src/version_tools → semantic_version_tools-1.3.3/src/semantic_version_tools}/version.py

@@ -2,6 +2,7 @@
 import re
 from importlib.metadata import version
 
+
 ###################################
 # Versioning Class
 ###################################
@@ -11,16 +12,9 @@ from importlib.metadata import version
 #
 # The versioning is based on the Semantic Versioning 2.0.0
 #
-# History:
-#
-# 2025-02-25: Moved to standalone module (1.3.0)
-# 2024-11-18: accept string as imput (1.2.0)
-# 2024-10-04: The patch is now not mandatory (1.1.0)
-# 2021-09-07: First implementation of the class (1.0.0)
 
 
-#__version__ = pkg_resources.get_distribution("version_tools").version
-__version__ = version('version_tools')
+__version__ = version('semantic_version_tools')
 
 code = {"d": "devel", "a": "alpha", "b": "beta", "rc": "ReleaseCandidate", "f": "Final"}
 
@@ -47,12 +41,15 @@ class Vers:
     """
 
     def __init__(self, ver: tuple | str) -> None:
+
         if isinstance(ver, str):
             a = re.match(
                 r"(\d+)\.(\d+)(?:\.(\d+))?(?:[-\.]([a-zA-Z]*)(?:\.?(\d+))?)?", ver
             )
             prt = list(a.groups())
-            prt[0:3] = [int(i) for i in prt[0:3]]
+            prt[0:2] = [int(i) for i in prt[0:2]]
+            if prt[2] is not None:
+                prt[2] = int(prt[2])
             if prt[3] is not None:
                 if prt[3].lower() in "development":
                     prt[3] = "d"
@@ -65,12 +62,14 @@ class Vers:
                 elif prt[3].lower() in "final":
                     prt[3] = "f"
             else:
-                prt[3] = "f"
+                prt[3] = None
             if prt[3] is not None and prt[4] is None:
-                prt[4] = 1
-            prt[4] = int(prt[4])
-            ver = tuple(prt)
-
+                prt[4] = None
+            else:
+                if prt[3] is not None:
+                    prt[4] = int(prt[4])
+            ver = tuple([x for x in prt if x is not None])
+        # print(ver)
         self._len = 3
         if len(ver) < 3:
             self.major, self.minor, *extra = ver
@@ -79,7 +78,7 @@ class Vers:
         else:
             self.major, self.minor, self.patch, *extra = ver
         # self.patch = extra[0] if extra else None
-        self.type = extra[0] if len(extra) != 0 else None
+        self.type = extra[0] if len(extra) != 0 else 'f'
         if self.type is not None:
             if not isinstance(self.type, str):
                 raise Exception(
@@ -90,7 +89,7 @@ class Vers:
                     f"the fourth element of the version mus be one of {
                                 ','.join(code.keys())}"
                 )
-        self.build = extra[1] if len(extra) > 1 else None
+        self.build = extra[1] if len(extra) > 1 else 1
 
     def full(self) -> str:
         """
@@ -180,5 +179,20 @@ class Vers:
         else:
             return False
 
-
+    def __add__(self, other:"Vers") -> "Vers":
+        
+        if isinstance(other,int):
+            self.minor += other
+            
+        if isinstance(other,float):
+            a=str(other).split(".")
+            self.major += int(a[0])
+            self.minor += int(a[1])
+            
+        if isinstance(other, Vers):
+            self.major += other.major
+            self.minor += other.minor
+            if self._len == 3:
+                self.patch += other.patch
+        return self
 # version = Vers(VERSION)

semantic_version_tools-1.3.0/PKG-INFO

@@ -1,38 +0,0 @@
-Metadata-Version: 2.3
-Name: semantic-version-tools
-Version: 1.3.0
-Summary: 
-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
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: setuptools (>=75.8.0,<76.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 version-tools
-```
-

semantic_version_tools-1.3.0/README.md

@@ -1,22 +0,0 @@
-
-# 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 version-tools
-```

semantic_version_tools-1.3.0/src/version_tools/__init__.py

@@ -1 +0,0 @@
-from version_tools.version import Vers