encommon 1.0.1__tar.gz → 1.1.1__tar.gz

{encommon-1.0.1/encommon.egg-info → encommon-1.1.1}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 1.0.1
+Version: 1.1.1
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.11
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: croniter
@@ -19,7 +20,8 @@ Requires-Dist: snaptime
 [![Validate](https://github.com/enasisnetwork/encommon/actions/workflows/build.yml/badge.svg)](https://github.com/enasisnetwork/encommon/actions/workflows/build.yml)
 [![Documentation Status](https://readthedocs.org/projects/encommon/badge/?version=latest)](https://encommon.readthedocs.io/en/latest/?badge=latest)
 
-Common classes and functions used in various public and private projects for [Enasis Network](https://github.com/enasisnetwork).
+Common classes and functions used in various public and private projects for
+[Enasis Network](https://github.com/enasisnetwork).
 
 ## Installing the package
 ```
@@ -28,8 +30,8 @@ pip install encommon
 
 ## Documentation
 Documentation can be found on [Read the Docs](https://encommon.readthedocs.io).
-However if you venture into the sections below you will be able to use the
-`sphinx` recipe to build the documention in `docs/html` for local viewing.
+If you venture into the sections below you will be able to use the `sphinx`
+recipe to build the documention in `docs/html` for local consumption.
 
 ## Quick start for local development
 Start by cloning the repository to your local machine.
@@ -42,7 +44,8 @@ make -s venv-create
 ```
 
 ### Execute the linters and tests
-The comprehensive approach is to use the `check` recipe. This will stop on any failure that is encountered.
+The comprehensive approach is to use the `check` recipe. This will stop on any
+failure that is encountered.
 ```
 make -s check
 ```
@@ -55,3 +58,13 @@ information found in the `htmlcov` folder in the root of the project.
 ```
 make -s pytest
 ```
+
+## Future features and subpackages
+
+### `netdom` subpackage
+This package will include class objects for handling network addresses and
+other functions to assist with validating and normalizing domain names.
+
+### `formats` subpackage
+This package will include class objects to help with dealing with verious
+formats of data. These formats will include Jinja2, CSV, and HTML.

{encommon-1.0.1 → encommon-1.1.1}/README.md

@@ -3,7 +3,8 @@
 [![Validate](https://github.com/enasisnetwork/encommon/actions/workflows/build.yml/badge.svg)](https://github.com/enasisnetwork/encommon/actions/workflows/build.yml)
 [![Documentation Status](https://readthedocs.org/projects/encommon/badge/?version=latest)](https://encommon.readthedocs.io/en/latest/?badge=latest)
 
-Common classes and functions used in various public and private projects for [Enasis Network](https://github.com/enasisnetwork).
+Common classes and functions used in various public and private projects for
+[Enasis Network](https://github.com/enasisnetwork).
 
 ## Installing the package
 ```
@@ -12,8 +13,8 @@ pip install encommon
 
 ## Documentation
 Documentation can be found on [Read the Docs](https://encommon.readthedocs.io).
-However if you venture into the sections below you will be able to use the
-`sphinx` recipe to build the documention in `docs/html` for local viewing.
+If you venture into the sections below you will be able to use the `sphinx`
+recipe to build the documention in `docs/html` for local consumption.
 
 ## Quick start for local development
 Start by cloning the repository to your local machine.
@@ -26,7 +27,8 @@ make -s venv-create
 ```
 
 ### Execute the linters and tests
-The comprehensive approach is to use the `check` recipe. This will stop on any failure that is encountered.
+The comprehensive approach is to use the `check` recipe. This will stop on any
+failure that is encountered.
 ```
 make -s check
 ```
@@ -39,3 +41,13 @@ information found in the `htmlcov` folder in the root of the project.
 ```
 make -s pytest
 ```
+
+## Future features and subpackages
+
+### `netdom` subpackage
+This package will include class objects for handling network addresses and
+other functions to assist with validating and normalizing domain names.
+
+### `formats` subpackage
+This package will include class objects to help with dealing with verious
+formats of data. These formats will include Jinja2, CSV, and HTML.

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/__init__.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/common.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/config.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/files.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/logger.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/paths.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/test/test_common.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/test/test_config.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/test/test_files.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/test/test_logger.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 
@@ -16,7 +16,7 @@ from ..logger import Logger
 from ..logger import Message
 from ...times.common import UNIXEPOCH
 from ...times.common import UNIXMPOCH
-from ...utils import strip_ansi
+from ...utils.stdout import strip_ansi
 
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/config/test/test_paths.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/conftest.py

@@ -1,8 +1,8 @@
 """
 Functions and routines associated with Enasis Network Common Library.
 
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """
 
 

{encommon-1.0.1 → encommon-1.1.1}/encommon/times/parse.py

@@ -240,6 +240,8 @@ def since_time(
 
 def duration(
     seconds: int,
+    compact: bool = True,
+    maximum: int = 6,
 ) -> str:
     """
     Convert provided the seconds into a human friendly format.
@@ -249,32 +251,54 @@ def duration(
     >>> duration(86400 * 700)
     '1y11mon5d'
 
+    Example
+    -------
+    >>> duration(86400 * 700, False, 2)
+    '1 year, 11 months'
+
     :param seconds: Period in seconds that will be iterated.
+    :param compact: Determines if output will be condensed.
+    :param maximum: Determines how many time units are shown.
+        Default value happens to be same number of time units
+        supported; year, month, week, day, hour, and minute.
     :returns: Human friendly format from the value in seconds.
     """
 
     if seconds < 60:
-        return f'{seconds}s'
+        return (
+            f'{seconds}s' if compact
+            else 'just now')
 
     groups = (
-        ('y', 31536000),
-        ('mon', 2592000),
-        ('w', 604800),
-        ('d', 86400),
-        ('h', 3600),
-        ('m', 60))
+        ('year', 'y', 31536000),
+        ('month', 'mon', 2592000),
+        ('week', 'w', 604800),
+        ('day', 'd', 86400),
+        ('hour', 'h', 3600),
+        ('minute', 'm', 60))
 
-    returned = []
+    returned: list[str] = []
 
-    for key, value in groups:
+    delimiter = '' if compact else ', '
+
+    for long, short, value in groups:
 
         if seconds < value:
             continue
 
         _value = seconds // value
 
+        key = short if compact else long
+
+        if not compact:
+            key = (
+                f' {key}' if _value == 1
+                else f' {key}s')
+
         returned.append(f'{_value}{key}')
 
         seconds %= value
 
-    return ''.join(returned)
+    returned = returned[:maximum]
+
+    return delimiter.join(returned)

{encommon-1.0.1 → encommon-1.1.1}/encommon/times/test/test_parse.py

@@ -223,35 +223,59 @@ def test_duration() -> None:
     quarter = day * 90
     year = day * 365
 
-    expects = {
 
-        year - 1: '12mon4d23h59m',
-        year: '1y',
-        year + 1: '1y',
+    expects = {
 
-        quarter - 1: '2mon4w1d23h59m',
-        quarter: '3mon',
-        quarter + 1: '3mon',
+        year: ('1y', '1 year'),
+        year + 1: ('1y', '1 year'),
+        year - 1: (
+            '12mon4d23h59m',
+            '12 months, 4 days'),
+
+        quarter: ('3mon', '3 months'),
+        quarter + 1: ('3mon', '3 months'),
+        quarter - 1: (
+            '2mon4w1d23h59m',
+            '2 months, 4 weeks'),
+
+        month: ('1mon', '1 month'),
+        month + 1: ('1mon', '1 month'),
+        month - 1: (
+            '4w1d23h59m',
+            '4 weeks, 1 day'),
+
+        week: ('1w', '1 week'),
+        week + 1: ('1w', '1 week'),
+        week - 1: (
+            '6d23h59m',
+            '6 days, 23 hours'),
+
+        day: ('1d', '1 day'),
+        day + 1: ('1d', '1 day'),
+        day - 1: (
+            '23h59m',
+            '23 hours, 59 minutes'),
+
+        hour: ('1h', '1 hour'),
+        hour + 1: ('1h', '1 hour'),
+        hour - 1: ('59m', '59 minutes'),
+
+        second: ('1m', '1 minute'),
+        second + 1: ('1m', '1 minute'),
+        second - 1: ('59s', 'just now')}
 
-        month - 1: '4w1d23h59m',
-        month: '1mon',
-        month + 1: '1mon',
 
-        week - 1: '6d23h59m',
-        week: '1w',
-        week + 1: '1w',
+    for source, expect in expects.items():
 
-        day - 1: '23h59m',
-        day: '1d',
-        day + 1: '1d',
+        durated = duration(
+            seconds=source,
+            compact=True)
 
-        hour - 1: '59m',
-        hour: '1h',
-        hour + 1: '1h',
+        assert durated == expect[0]
 
-        second - 1: '59s',
-        second: '1m',
-        second + 1: '1m'}
+        durated = duration(
+            seconds=source,
+            compact=False,
+            maximum=2)
 
-    for source, expect in expects.items():
-        assert duration(source) == expect
+        assert durated == expect[1]

encommon-1.1.1/encommon/utils/test/__init__.py

@@ -0,0 +1,6 @@
+"""
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+"""

encommon-1.1.1/encommon/version.txt

@@ -0,0 +1 @@
+1.1.1

{encommon-1.0.1 → encommon-1.1.1/encommon.egg-info}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 1.0.1
+Version: 1.1.1
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.11
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: croniter
@@ -19,7 +20,8 @@ Requires-Dist: snaptime
 [![Validate](https://github.com/enasisnetwork/encommon/actions/workflows/build.yml/badge.svg)](https://github.com/enasisnetwork/encommon/actions/workflows/build.yml)
 [![Documentation Status](https://readthedocs.org/projects/encommon/badge/?version=latest)](https://encommon.readthedocs.io/en/latest/?badge=latest)
 
-Common classes and functions used in various public and private projects for [Enasis Network](https://github.com/enasisnetwork).
+Common classes and functions used in various public and private projects for
+[Enasis Network](https://github.com/enasisnetwork).
 
 ## Installing the package
 ```
@@ -28,8 +30,8 @@ pip install encommon
 
 ## Documentation
 Documentation can be found on [Read the Docs](https://encommon.readthedocs.io).
-However if you venture into the sections below you will be able to use the
-`sphinx` recipe to build the documention in `docs/html` for local viewing.
+If you venture into the sections below you will be able to use the `sphinx`
+recipe to build the documention in `docs/html` for local consumption.
 
 ## Quick start for local development
 Start by cloning the repository to your local machine.
@@ -42,7 +44,8 @@ make -s venv-create
 ```
 
 ### Execute the linters and tests
-The comprehensive approach is to use the `check` recipe. This will stop on any failure that is encountered.
+The comprehensive approach is to use the `check` recipe. This will stop on any
+failure that is encountered.
 ```
 make -s check
 ```
@@ -55,3 +58,13 @@ information found in the `htmlcov` folder in the root of the project.
 ```
 make -s pytest
 ```
+
+## Future features and subpackages
+
+### `netdom` subpackage
+This package will include class objects for handling network addresses and
+other functions to assist with validating and normalizing domain names.
+
+### `formats` subpackage
+This package will include class objects to help with dealing with verious
+formats of data. These formats will include Jinja2, CSV, and HTML.

{encommon-1.0.1 → encommon-1.1.1}/pyproject.toml

@@ -12,9 +12,10 @@ license.text = "MIT"
 
 classifiers = [
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11"]
 
-requires-python = ">= 3.11"
+requires-python = ">= 3.10"
 
 dynamic = ["version", "dependencies"]
 

encommon-1.0.1/encommon/config/test/__init__.py

@@ -1,6 +0,0 @@
-"""
-Functions and routines associated with Enasis Network Common Library.
-
-This file is part of Enasis Network software eco-system. Distribution is
-permitted, for more information consult the project license file.
-"""

encommon-1.0.1/encommon/version.txt

@@ -1 +0,0 @@
-1.0.1