mmeutils 0.0.3__tar.gz

mmeutils-0.0.3/MANIFEST.in

@@ -0,0 +1 @@
+exclude-recursively = __pycache__ .mypy_cache .pytest_cache *.py[cod]

mmeutils-0.0.3/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: mmeutils
+Version: 0.0.3
+Summary: Some simple personal utility functions.
+Home-page: https://github.com/prof79/py-mmeutils
+Author: Markus M. Egger
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Text Processing :: General
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# mmeutils
+
+A simple collection of personal Python utility functions required in multiple hobbyist projects.
+
+## Installation
+
+```shell
+$ py -m pip install mmeutils
+```
+
+## Version History
+
+### 0.0.1-0.0.3
+
+Alpha in-progress

mmeutils-0.0.3/README.md

@@ -0,0 +1,15 @@
+# mmeutils
+
+A simple collection of personal Python utility functions required in multiple hobbyist projects.
+
+## Installation
+
+```shell
+$ py -m pip install mmeutils
+```
+
+## Version History
+
+### 0.0.1-0.0.3
+
+Alpha in-progress

mmeutils-0.0.3/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

mmeutils-0.0.3/setup.cfg

@@ -0,0 +1,41 @@
+[metadata]
+name = mmeutils
+version = 0.0.3
+author = Markus M. Egger
+url = https://github.com/prof79/py-mmeutils
+description = Some simple personal utility functions.
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = MIT
+license_files = LICENSE.txt
+classifiers = 
+	License :: OSI Approved :: MIT License
+	Development Status :: 3 - Alpha
+	Intended Audience :: Developers
+	Operating System :: OS Independent
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.9
+	Topic :: Text Processing :: General
+	Topic :: Utilities
+	Typing :: Typed
+
+[options]
+package_dir = 
+	=src
+packages = find:
+include_package_data = True
+python_requires = >=3.9
+
+[options.packages.find]
+where = src
+exclude = 
+	test*
+	temp*
+
+[tool: pytest]
+testpaths = src/test/
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

mmeutils-0.0.3/src/mmeutils/__init__.py

@@ -0,0 +1,11 @@
+"""mmeutils
+
+Some simple personal utility functions.
+"""
+
+
+from typing import List
+
+
+__all__: List[str] = [
+]

mmeutils-0.0.3/src/mmeutils/fileio/__init__.py

@@ -0,0 +1,76 @@
+"""File Input/Output Utility Functions"""
+
+
+from typing import List, Optional
+
+
+__all__: List[str] = [
+    'read_text_file_to_string',
+    'validate_json_file',
+]
+
+
+import json
+
+from logging import debug
+from pathlib import Path
+
+
+def read_text_file_to_string(file_name: Optional[str|Path]) -> str:
+    """Read contents of a text file into a single string.
+
+    Lines will be normalized ie. stripped and empty lines discarded.
+    Lines will then be joined using the line-separation character (\\n).
+
+    :param file_name: Name/path of the file to process.
+    :type file_name: Optional[str|Path]
+
+    :return: A string of all the non-empty lines joined by \\n.
+    :rtype: str
+    """
+    with open(str(file_name), 'r', encoding='utf-8') as file:
+        from ..textio import strip_discard_empty_lines
+
+        lines = strip_discard_empty_lines(file.readlines())
+        return '\n'.join(lines)
+
+
+def validate_json_file(file_name: Optional[str|Path]) -> bool:
+    """Validate that a JSON file is neither empty nor invalid.
+
+    Empty means all whitespace, an empty object or an empty array.
+    Invalid means it cannot be parsed as valid JSON.
+    And the file must exist in the first place.
+
+    :param file_name: Name/path of the JSON file to check.
+    :type file_name: Optional[str|Path]
+
+    :return: True if file exists and has valid non-empty JSON content.
+        False otherwise.
+    :rtype: bool
+    """
+
+    if not Path(str(file_name)).exists():
+        debug(f'validate_json_file(): File {str(file_name)} not found')
+        return False
+
+    contents = read_text_file_to_string(file_name)
+
+    if contents == '':
+        debug(f'validate_json_file(): {str(file_name)} is empty')
+        return False
+
+    try:
+        obj = json.loads(contents)
+
+        if len(obj) == 0:
+            debug(f'validate_json_file(): {str(file_name)} has empty object/array')
+            return False
+        
+        else:
+            debug(f'validate_json_file(): {str(file_name)} is valid')
+            return True
+    
+    except json.JSONDecodeError as jde:
+        debug(f'validate_json_file(): {str(file_name)} is invalid: {jde}')
+        return False

mmeutils-0.0.3/src/mmeutils/textio/__init__.py

@@ -0,0 +1,30 @@
+"""Text Input/Output Utility Functions"""
+
+
+from typing import Iterable, List
+
+
+__all__: List[str] = [
+    'strip_discard_empty_lines',
+]
+
+
+def strip_discard_empty_lines(lines: Iterable[str]) -> list[str]:
+    """Sanitizes string lines in an iterable such that:
+
+    * Leading and trailing whitespace is discarded ("strip()")
+    * Empty lines (including whitespace-only) are discarded
+
+    :param lines: An iterable of string lines to process
+    :type lines: Iterable[st]
+
+    :return: The list of normalized (non-empty) strings.
+    :rtype: list[str]
+    """
+    return list(
+        [
+            line.strip()
+            for line in lines
+            if line.strip()
+        ]
+    )

mmeutils-0.0.3/src/mmeutils.egg-info/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: mmeutils
+Version: 0.0.3
+Summary: Some simple personal utility functions.
+Home-page: https://github.com/prof79/py-mmeutils
+Author: Markus M. Egger
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Text Processing :: General
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# mmeutils
+
+A simple collection of personal Python utility functions required in multiple hobbyist projects.
+
+## Installation
+
+```shell
+$ py -m pip install mmeutils
+```
+
+## Version History
+
+### 0.0.1-0.0.3
+
+Alpha in-progress

mmeutils-0.0.3/src/mmeutils.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE.txt
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+src/mmeutils/__init__.py
+src/mmeutils.egg-info/PKG-INFO
+src/mmeutils.egg-info/SOURCES.txt
+src/mmeutils.egg-info/dependency_links.txt
+src/mmeutils.egg-info/top_level.txt
+src/mmeutils/fileio/__init__.py
+src/mmeutils/textio/__init__.py

mmeutils-0.0.3/src/mmeutils.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mmeutils-0.0.3/src/mmeutils.egg-info/top_level.txt

@@ -0,0 +1 @@
+mmeutils