encommon 1.0.1__py3-none-any.whl → 1.1.1__py3-none-any.whl

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/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/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/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/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/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/config/test/__init__.py

@@ -1,6 +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.
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
 """

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/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/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/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/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/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/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/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/version.txt

@@ -1 +1 @@
-1.0.1
+1.1.1

{encommon-1.0.1.dist-info → encommon-1.1.1.dist-info}/METADATA

@@ -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.dist-info → encommon-1.1.1.dist-info}/RECORD

@@ -1,19 +1,19 @@
 encommon/__init__.py,sha256=VoXUcphq-gcXCraaU47EtXBftF6UVuQPMGr0fuCTt9A,525
-encommon/conftest.py,sha256=OkzXA-CdP3RiFqhtaL3nF5Qdt0LFsajrQaOZ_3BWaQo,772
+encommon/conftest.py,sha256=D_8TAxCdBXYyUacz6V5Iovgka7mn7pXH_rBcx8xbLEg,772
 encommon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-encommon/version.txt,sha256=ROFh5ElcrCz3hYBD6eZBjpV58N3ProJvmjcmIpaM4GY,6
-encommon/config/__init__.py,sha256=ZimcFRtWo22L_fKgfVnY8YcwkVQ_DeC3AV_3TVO-Z1c,469
-encommon/config/common.py,sha256=gWJ3usayN6yKNdXikFoM4Y0lmQTphkV7-2xJmVFo4SA,1961
-encommon/config/config.py,sha256=VnxPHPz5rKqQ-T6HqffMBUvEoqlR1dykH_F_yqgTqik,4282
-encommon/config/files.py,sha256=2aqv0kfM26xQBZ38D7bzN9pH-cnX0vYlfmfbkI-PKDs,1535
-encommon/config/logger.py,sha256=dQe5JQy0hWH-7skK_mSmGb9hOBikR0o8pWMGoNYrqQs,13510
-encommon/config/paths.py,sha256=9T5upahVfUZ8zYDo8AU2ab5ESvORUs2LVXjj3PsSsHM,1729
-encommon/config/test/__init__.py,sha256=ieWgzVdaxhiaP_GnfdCtcSEaRW56vnpKXVsCLhqaask,218
-encommon/config/test/test_common.py,sha256=Jr3myDlIPKy-rKUOaX_awjGwD1PJZsf1ZSiK6XIvqXc,731
-encommon/config/test/test_config.py,sha256=e5MUkQmL9xAueAezBkciPDFqGP9hDNyM7Bt0JylNhHg,3196
-encommon/config/test/test_files.py,sha256=uxNUXtn3qhsdokixEb20P2Y1IOSMQICk6_uNGyQlhb4,1300
-encommon/config/test/test_logger.py,sha256=7kdhGsza0_9IBOHrs36sTuOeU8KFkQCMwJuSTVz75MQ,4359
-encommon/config/test/test_paths.py,sha256=IWkp2Xyaxs9IIx33nfPyhN_9FCdSsp8FFxMmP2XcNSQ,1167
+encommon/version.txt,sha256=zFL2eISLgUNzdXtGA4O_YZYOSUPCA3Na3eCjULPlCYk,6
+encommon/config/__init__.py,sha256=tCvJrBTdtNSyg3sZkwUFQBwtK8QHgxLQl833OxblKAo,469
+encommon/config/common.py,sha256=_DEkMJnIftu4opDzvfOEdwQ6DF66nenS4mmtQKctVNA,1961
+encommon/config/config.py,sha256=F9ptyCX-IqTc-UrC9JhP6zWESeOPJkpECjnhdh82ynA,4282
+encommon/config/files.py,sha256=RlAk9iCH7JNYubDQe7IeenKuPY1l8h-DCPcmw2Qv9fI,1535
+encommon/config/logger.py,sha256=B3c7WQQcyWgUIFYu0h4k5YFE75PADwaUyTAGFUVxi_A,13510
+encommon/config/paths.py,sha256=NIt4jQy2SalEXuOyZqSdin_3LzLADsqp44bH8tm8RQU,1729
+encommon/config/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
+encommon/config/test/test_common.py,sha256=U6XWfCLxtLmArn8P6h4cmCALzdXxV7IMUxKNU-UhwPw,731
+encommon/config/test/test_config.py,sha256=D0RsIH9rQaf2OLN9vUzbGsszRXNbc7pBK7n6LySDyD0,3196
+encommon/config/test/test_files.py,sha256=KUdPUvDzBPL9jTRTjJ5nRUOti5i8Z_MF1aBTSHUpmLM,1300
+encommon/config/test/test_logger.py,sha256=Ya0lVnOB97M6FTRwxbmcKcULUGW_nPt4bLCdSRHbTQI,4366
+encommon/config/test/test_paths.py,sha256=SlDJnUeW9JK9Hu3B-QCdHadwPDeqdfzqa-73YYbeefQ,1167
 encommon/crypt/__init__.py,sha256=y8TS6RKrKseH6mMSjEULrVkl6-KbevH0yZiWmIWj1UA,315
 encommon/crypt/crypt.py,sha256=MvKTUv2CnHqEofODzJWI-dropZULKQlVSJ6Y7BJQzHc,3147
 encommon/crypt/hashes.py,sha256=PNw-leN3Mx2U1-aVrjK2ueK3b2qXwwXj4rLEMC85DpY,2797
@@ -22,13 +22,13 @@ encommon/crypt/test/test_crypt.py,sha256=iiIIvQ8YaegpKsfcAxs-zbFh7qyrGrh8A7b_Q9z
 encommon/crypt/test/test_hashes.py,sha256=Q6OUtDe6-lWS31x6-YdjPqaxLQ4yBUAeA04qXjSanC4,1086
 encommon/times/__init__.py,sha256=Yr6rd_bflwOR4XcYkJ3bKKO4HoWI4d8G8PH7eAEfKkc,591
 encommon/times/common.py,sha256=zDI5ztMkfLmV090jlLLK3hFzGGveasy8I_wNfOQDScg,2500
-encommon/times/parse.py,sha256=Th24yCy7tRJoUpCuoP7tuJlwsqHSkTEw7_FES_3tMpU,7168
+encommon/times/parse.py,sha256=ffk-Az5nF24EFE1xbkh9Jp-JjTlTp1hRf8AKTXeZ8pQ,7917
 encommon/times/timer.py,sha256=dsxGgxQ-I75nnwcY9qdxuYD6TdCbhof2KvJuPcatimw,3200
 encommon/times/times.py,sha256=xpaZ1F25VHj6s862doLQWqmPf9yrj1lkN-BILRH3sPw,8947
 encommon/times/window.py,sha256=Fx_OJfU9B0IctCyaJ5XH_HxzhGlzeRATwuhI-HlsTPA,8023
 encommon/times/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 encommon/times/test/test_common.py,sha256=nizxgB1scLDEm2o66waK1Ar_Dl5BBMTC-GRV7iDk0_U,1477
-encommon/times/test/test_parse.py,sha256=23DPaAvoRaXPVRMlxzxev2iYk2hcnHNl6kWPEhdn4MQ,5242
+encommon/times/test/test_parse.py,sha256=AhOblR9xN3BUTc4Em-hD432hVECnCWE1OmmYM_fZsmU,5911
 encommon/times/test/test_timer.py,sha256=hGpvUt3Hz0v-OfWZtU8gRhkGCEFJ12LV2b5MVzb-PDs,1407
 encommon/times/test/test_times.py,sha256=hiDdsbrRhj0E5-XO_2EHXdhca73jdiP3rcK2mPbNkSg,1954
 encommon/times/test/test_window.py,sha256=AX2xIjtzSrXUe9MTci69z-1Si0Tw5ZHdLS7WB69Qw_A,4829
@@ -49,8 +49,8 @@ encommon/utils/test/test_paths.py,sha256=ZPU84G_vI13G6t-PtDhM9UG4SHOoF4TiEdqApxt
 encommon/utils/test/test_regexp.py,sha256=oJglz-8TJiSUtE7NuseFy0dVjau2jR1foEj-ZsBlcek,697
 encommon/utils/test/test_sample.py,sha256=EZnRI27qf7x3s7Xbtkd9t0o_y1xDQB0o2sPxbO0_dDQ,1465
 encommon/utils/test/test_stdout.py,sha256=a060uA8oEHFGoVqdwB5iYxdl4R2TRSgr6Z7pMEbxibs,1675
-encommon-1.0.1.dist-info/LICENSE,sha256=04XJC5i4LRUf1A_U1EGCMJLpGodnmOFlh30yu7FAVfs,1071
-encommon-1.0.1.dist-info/METADATA,sha256=2tbrkbopSDaELQpAgJFiM2sBM1TCL8lBnIZkjUgm50k,1869
-encommon-1.0.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-encommon-1.0.1.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-1.0.1.dist-info/RECORD,,
+encommon-1.1.1.dist-info/LICENSE,sha256=04XJC5i4LRUf1A_U1EGCMJLpGodnmOFlh30yu7FAVfs,1071
+encommon-1.1.1.dist-info/METADATA,sha256=oG0BIP6K8ILaeVJxVOC2x2Rs3W5T70Fk9pxttBaGyGo,2291
+encommon-1.1.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+encommon-1.1.1.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
+encommon-1.1.1.dist-info/RECORD,,