encommon 0.12.0__tar.gz → 0.12.1__tar.gz

{encommon-0.12.0/encommon.egg-info → encommon-0.12.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.12.0
+Version: 0.12.1
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -74,16 +74,33 @@ information found in the `htmlcov` folder in the root of the project.
 make -s pytest
 ```
 
-## Build and upload to PyPi
-Build the package.
-```
-make -s pypackage
-```
-Upload to the test PyPi.
-```
-make -s pypi-upload-test
-```
-Upload to the prod PyPi.
-```
-make -s pypi-upload-prod
-```
+## Version management
+:warning: Ensure that no changes are pending.
+
+1. Rebuild the environment.
+   ```
+   make -s check-revenv
+   ```
+
+1. Update the [version.txt](encommon/version.txt) file.
+
+1. Push to the `main` branch.
+
+1. Create [repository](https://github.com/enasisnetwork/encommon) release.
+
+1. Build the Python package.<br>
+   ```
+   make -s pypackage
+   ```
+
+1. Upload Python package to PyPi test.
+   ```
+   make -s pypi-upload-test
+   ```
+
+1. Upload Python package to PyPi prod.
+   ```
+   make -s pypi-upload-prod
+   ```
+
+1. Update [Read the Docs](https://encommon.readthedocs.io) documentation.

{encommon-0.12.0 → encommon-0.12.1}/README.md

@@ -55,16 +55,33 @@ information found in the `htmlcov` folder in the root of the project.
 make -s pytest
 ```
 
-## Build and upload to PyPi
-Build the package.
-```
-make -s pypackage
-```
-Upload to the test PyPi.
-```
-make -s pypi-upload-test
-```
-Upload to the prod PyPi.
-```
-make -s pypi-upload-prod
-```
+## Version management
+:warning: Ensure that no changes are pending.
+
+1. Rebuild the environment.
+   ```
+   make -s check-revenv
+   ```
+
+1. Update the [version.txt](encommon/version.txt) file.
+
+1. Push to the `main` branch.
+
+1. Create [repository](https://github.com/enasisnetwork/encommon) release.
+
+1. Build the Python package.<br>
+   ```
+   make -s pypackage
+   ```
+
+1. Upload Python package to PyPi test.
+   ```
+   make -s pypi-upload-test
+   ```
+
+1. Upload Python package to PyPi prod.
+   ```
+   make -s pypi-upload-prod
+   ```
+
+1. Update [Read the Docs](https://encommon.readthedocs.io) documentation.

{encommon-0.12.0 → encommon-0.12.1}/encommon/config/logger.py

@@ -266,6 +266,9 @@ class Message:
 class FileFormatter(Formatter):
     """
     Supplement class for built-in logger exception formatter.
+
+    .. note::
+       Input parameters are not defined, check parent class.
     """
 
 

{encommon-0.12.0 → encommon-0.12.1}/encommon/config/params.py

@@ -37,8 +37,6 @@ class LoggerParams(BaseModel, extra='forbid'):
     :param stdo_level: Minimum level for the message to pass.
     :param file_level: Minimum level for the message to pass.
     :param file_path: Enables writing to the filesystem path.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
     stdo_level: Optional[LOGLEVELS] = None

{encommon-0.12.0 → encommon-0.12.1}/encommon/times/params.py

@@ -24,8 +24,6 @@ class TimerParams(BaseModel, extra='forbid'):
 
     :param timer: Seconds that are used for related timer.
     :param start: Optional time for when the timer started.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
     timer: float
@@ -81,8 +79,6 @@ class WindowParams(BaseModel, extra='forbid'):
     :param stop: Determine the ending for scheduling window.
     :param anchor: Optionally define time anchor for window.
     :param delay: Period of time schedulng will be delayed.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
     window: SCHEDULE

{encommon-0.12.0 → encommon-0.12.1}/encommon/times/timers.py

@@ -36,6 +36,9 @@ TIMERS = dict[str, Timer]
 class SQLBase(DeclarativeBase):
     """
     Some additional class that SQLAlchemy requires to work.
+
+    .. note::
+       Input parameters are not defined, check parent class.
     """
 
 
@@ -48,8 +51,6 @@ class TimersTable(SQLBase):
        Fields are not completely documented for this model.
     """
 
-    __tablename__ = 'timers'
-
     group = Column(
         String,
         primary_key=True,
@@ -64,6 +65,8 @@ class TimersTable(SQLBase):
         String,
         nullable=False)
 
+    __tablename__ = 'timers'
+
 
 
 class Timers:
@@ -249,18 +252,20 @@ class Timers:
         group = self.__group
 
         session = self.store_session
-        table = TimersTable
-
 
         config = params.timers
 
 
-        records = (
-            session.query(table)
-            .filter(table.group == group)
-            .order_by(table.unique))
+        _table = TimersTable
+        _group = _table.group
+        _unique = _table.unique
+
+        query = (
+            session.query(_table)
+            .filter(_group == group)
+            .order_by(_unique))
 
-        for record in records.all():
+        for record in query.all():
 
             unique = str(record.unique)
             update = str(record.update)
@@ -324,6 +329,7 @@ class Timers:
 
 
         session.commit()
+        session.close()
 
 
     def ready(

{encommon-0.12.0 → encommon-0.12.1}/encommon/times/windows.py

@@ -36,6 +36,9 @@ WINDOWS = dict[str, Window]
 class SQLBase(DeclarativeBase):
     """
     Some additional class that SQLAlchemy requires to work.
+
+    .. note::
+       Input parameters are not defined, check parent class.
     """
 
 
@@ -48,8 +51,6 @@ class WindowsTable(SQLBase):
        Fields are not completely documented for this model.
     """
 
-    __tablename__ = 'windows'
-
     group = Column(
         String,
         primary_key=True,
@@ -72,6 +73,8 @@ class WindowsTable(SQLBase):
         String,
         nullable=False)
 
+    __tablename__ = 'windows'
+
 
 
 class Windows:
@@ -298,18 +301,20 @@ class Windows:
         group = self.__group
 
         session = self.store_session
-        table = WindowsTable
-
 
         config = params.windows
 
 
-        records = (
-            session.query(table)
-            .filter(table.group == group)
-            .order_by(table.unique))
+        _table = WindowsTable
+        _group = _table.group
+        _unique = _table.unique
+
+        query = (
+            session.query(_table)
+            .filter(_group == group)
+            .order_by(_unique))
 
-        for record in records.all():
+        for record in query.all():
 
             unique = str(record.unique)
             next = str(record.next)
@@ -394,6 +399,7 @@ class Windows:
 
 
         session.commit()
+        session.close()
 
 
     def ready(

encommon-0.12.1/encommon/version.txt

@@ -0,0 +1 @@
+0.12.1

{encommon-0.12.0 → encommon-0.12.1/encommon.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.12.0
+Version: 0.12.1
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -74,16 +74,33 @@ information found in the `htmlcov` folder in the root of the project.
 make -s pytest
 ```
 
-## Build and upload to PyPi
-Build the package.
-```
-make -s pypackage
-```
-Upload to the test PyPi.
-```
-make -s pypi-upload-test
-```
-Upload to the prod PyPi.
-```
-make -s pypi-upload-prod
-```
+## Version management
+:warning: Ensure that no changes are pending.
+
+1. Rebuild the environment.
+   ```
+   make -s check-revenv
+   ```
+
+1. Update the [version.txt](encommon/version.txt) file.
+
+1. Push to the `main` branch.
+
+1. Create [repository](https://github.com/enasisnetwork/encommon) release.
+
+1. Build the Python package.<br>
+   ```
+   make -s pypackage
+   ```
+
+1. Upload Python package to PyPi test.
+   ```
+   make -s pypi-upload-test
+   ```
+
+1. Upload Python package to PyPi prod.
+   ```
+   make -s pypi-upload-prod
+   ```
+
+1. Update [Read the Docs](https://encommon.readthedocs.io) documentation.

encommon-0.12.0/encommon/version.txt

@@ -1 +0,0 @@
-0.12.0