arin-log 0.2.0__tar.gz → 0.2.2__tar.gz

{arin_log-0.2.0 → arin_log-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arin-log
-Version: 0.2.0
+Version: 0.2.2
 Summary: A lightweight logging package for long-running pipelines: a virtual assistant for the user, a clean archive for the developer.
 Author-email: Marcus Aurelius <marcus.aurelius.hu@gmail.com>
 License-Expression: MIT
@@ -115,6 +115,66 @@ my_pipeline ; 14:32:11 ; completed
 
 ---
 
+## Public API
+
+All functions and helpers below are available directly from the
+package:
+
+```python
+from arin_log import (
+    # Logger
+    log_start, log_notes, log_except, log_exit,
+    config_logs, file_exist,
+    # Helpers
+    tijd, tas, cls,
+    load_json, save_json,
+    # Folder
+    change_folder, get_folder,
+    # Console
+    cons_menu,
+)
+```
+
+| Name | Purpose |
+|------|---------|
+| `log_start` | Mark the start of a run and refresh the daily log date |
+| `log_notes` | Write notes to the console and/or the log file |
+| `log_except` | Log an exception with `module.function.line` info |
+| `log_exit` | Mark the end of a run (and optionally exit the process) |
+| `config_logs` | Load the colors from `config_log.json` |
+| `file_exist` | Check if a file exists, with an optional wait time |
+| `tijd` | Return the current time as `HH:MM:SS` |
+| `tas` | Today as string (`YYYY-MM-DD`), set at import |
+| `cls` | Clear the console (Windows: `cls`, otherwise `clear`) |
+| `load_json` | Read a JSON file, return `{}` if missing or corrupt |
+| `save_json` | Write data as JSON, return `True` or `False` |
+| `change_folder` | Open the folder dialog and update the config |
+| `get_folder` | Return the current log folder |
+| `cons_menu` | Show a console menu and return the chosen command |
+
+---
+
+## JSON helpers
+
+`arin_log` ships with two JSON helpers, available directly from the
+package:
+
+```python
+from arin_log import load_json, save_json
+
+data = load_json("myfile.json")
+save_json("myfile.json", data, indent=4)
+```
+
+`load_json` returns `{}` if the file is missing or corrupt.
+`save_json` returns `True` on success, `False` on failure.
+
+These helpers come with `arin_log` because most modules already
+import the package — so they are available wherever you need them,
+without an extra dependency.
+
+---
+
 ## What makes `arin_log` different?
 
 | Aspect | `arin_log` | Loguru / stdlib / structlog |
@@ -132,13 +192,16 @@ console and archive + Arin.
 
 ## How it works
 
-The package consists of four modules, each with a clear task:
+The package consists of three modules, each with a clear task:
 
 - **`logger.py`** — the heart: `log_start`, `log_notes`, `log_except`,
-  `log_exit`, and the helpers.
+  `log_exit`, plus the helpers `tijd`, `tas`, `cls`, `load_json`,
+  `save_json`, and `config_logs`.
 - **`folder.py`** — manages the config folder and the log folder.
-- **`console.py`** — console interaction: clear screen, menus.
-- **`utils.py`** — JSON helpers (`load_json`, `save_json`).
+- **`console.py`** — console interaction: menus.
+
+**`utils.py`** remains as an internal helper for `folder.py` only.
+It is not part of the public API.
 
 ### Configuration
 
@@ -182,4 +245,4 @@ MIT — see [LICENSE](LICENSE).
 
 ## Status
 
-**Alpha (0.2.0).** The core works. Tests are still in development.
+**Alpha (0.2.2).** The core works. Tests are still in development.

{arin_log-0.2.0 → arin_log-0.2.2}/README.md

@@ -90,6 +90,66 @@ my_pipeline ; 14:32:11 ; completed
 
 ---
 
+## Public API
+
+All functions and helpers below are available directly from the
+package:
+
+```python
+from arin_log import (
+    # Logger
+    log_start, log_notes, log_except, log_exit,
+    config_logs, file_exist,
+    # Helpers
+    tijd, tas, cls,
+    load_json, save_json,
+    # Folder
+    change_folder, get_folder,
+    # Console
+    cons_menu,
+)
+```
+
+| Name | Purpose |
+|------|---------|
+| `log_start` | Mark the start of a run and refresh the daily log date |
+| `log_notes` | Write notes to the console and/or the log file |
+| `log_except` | Log an exception with `module.function.line` info |
+| `log_exit` | Mark the end of a run (and optionally exit the process) |
+| `config_logs` | Load the colors from `config_log.json` |
+| `file_exist` | Check if a file exists, with an optional wait time |
+| `tijd` | Return the current time as `HH:MM:SS` |
+| `tas` | Today as string (`YYYY-MM-DD`), set at import |
+| `cls` | Clear the console (Windows: `cls`, otherwise `clear`) |
+| `load_json` | Read a JSON file, return `{}` if missing or corrupt |
+| `save_json` | Write data as JSON, return `True` or `False` |
+| `change_folder` | Open the folder dialog and update the config |
+| `get_folder` | Return the current log folder |
+| `cons_menu` | Show a console menu and return the chosen command |
+
+---
+
+## JSON helpers
+
+`arin_log` ships with two JSON helpers, available directly from the
+package:
+
+```python
+from arin_log import load_json, save_json
+
+data = load_json("myfile.json")
+save_json("myfile.json", data, indent=4)
+```
+
+`load_json` returns `{}` if the file is missing or corrupt.
+`save_json` returns `True` on success, `False` on failure.
+
+These helpers come with `arin_log` because most modules already
+import the package — so they are available wherever you need them,
+without an extra dependency.
+
+---
+
 ## What makes `arin_log` different?
 
 | Aspect | `arin_log` | Loguru / stdlib / structlog |
@@ -107,13 +167,16 @@ console and archive + Arin.
 
 ## How it works
 
-The package consists of four modules, each with a clear task:
+The package consists of three modules, each with a clear task:
 
 - **`logger.py`** — the heart: `log_start`, `log_notes`, `log_except`,
-  `log_exit`, and the helpers.
+  `log_exit`, plus the helpers `tijd`, `tas`, `cls`, `load_json`,
+  `save_json`, and `config_logs`.
 - **`folder.py`** — manages the config folder and the log folder.
-- **`console.py`** — console interaction: clear screen, menus.
-- **`utils.py`** — JSON helpers (`load_json`, `save_json`).
+- **`console.py`** — console interaction: menus.
+
+**`utils.py`** remains as an internal helper for `folder.py` only.
+It is not part of the public API.
 
 ### Configuration
 
@@ -157,4 +220,4 @@ MIT — see [LICENSE](LICENSE).
 
 ## Status
 
-**Alpha (0.2.0).** The core works. Tests are still in development.
+**Alpha (0.2.2).** The core works. Tests are still in development.

{arin_log-0.2.0 → arin_log-0.2.2}/arin_log/__init__.py

@@ -18,7 +18,8 @@ Publieke API
 ------------
 Vanuit de logger:
     log_start, log_notes, log_except, log_exit,
-    config_logs, file_exist, tijd
+    config_logs, file_exist, tijd, tas,
+    load_json, save_json, cls
 
 Vanuit de folder:
     change_folder, get_folder
@@ -27,13 +28,12 @@ Vanuit de console:
     cons_menu
 
 Interne functies blijven bereikbaar via hun eigen module, bijvoorbeeld:
-    from arin_log.logger import not_set
+    from arin_log.logger import not_set, last_record
     from arin_log.folder import get_config
-    from arin_log.utils import load_json, save_json
-    from arin_log.console import cls, menu_dict
+    from arin_log.console import menu_dict
 """
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 
 from arin_log.logger import (
     log_start,
@@ -43,6 +43,10 @@ from arin_log.logger import (
     config_logs,
     file_exist,
     tijd,
+    tas,
+    load_json,
+    save_json,
+    cls,
 )
 
 from arin_log.folder import (
@@ -62,6 +66,10 @@ __all__ = [
     "config_logs",
     "file_exist",
     "tijd",
+    "tas",
+    "load_json",
+    "save_json",
+    "cls",
     "change_folder",
     "get_folder",
     "cons_menu",

{arin_log-0.2.0 → arin_log-0.2.2}/arin_log/console.py

@@ -4,26 +4,20 @@ console.py
 Console-interactie voor arin_log.
 
 Bevat:
-    cls()                    - wist het scherm (Windows: cls, anders clear)
     menu_dict(optlst)        - bouwt een dict van genummerde menu-opties
     cons_menu(optlst, ...)   - toont een console-menu en retourneert
                                de gekozen functie als commando-string.
 
+`cls()` woont in logger.py en is daar publiek.
+
 Dit is een aparte module omdat console-interactie (menu, scherm wissen)
 niets met loggen te maken heeft. De logger logt; de console toont.
 """
 
-from os import system, name, path
-from arin_log.logger import log_notes
+from os import path
+from arin_log.logger import log_notes, cls
 
 br = chr(10)
-prgnm = path.basename(__file__).split('.')[0]
-
-
-def cls():
-    """Wist het scherm. Op Windows met 'cls', anders met 'clear'."""
-    system('cls' if name == 'nt' else 'clear')
-    return
 
 
 def menu_dict(optlst):
@@ -88,4 +82,5 @@ def cons_menu(optlst, logloc=None):
                 com = 'exit(0)'
             else:
                 com = f'{com}()'
-    return com
+    return com
+    

arin_log-0.2.2/arin_log/log_cnfg.json

@@ -0,0 +1 @@
+{"color_codes":{"black":"30m","blue":"34m","cyan":"36m","darkgrey":"90m","green":"32m","lightblue":"94m","lightcyan":"96m","lightgreen":"92m","lightgrey":"37m","lightred":"91m","orange":"33m","pink":"95m","purple":"35m","red":"31m","yellow":"93m"},"color_words":{"Arin":"cyan","completed":"cyan","modification":"cyan","pending":"cyan","terminated":"cyan","satisfied":"cyan","shutdown":"cyan","startup":"cyan","rebooted":"cyan","recovery":"cyan","running":"cyan","updated":"cyan","added":"green","succes":"green","success":"green","present":"green","restored":"green","saved":"green","corrupt":"lightred","error":"lightred","empty":"lightred","fail":"lightred","false":"lightred","inexistent":"lightred","invalid":"lightred","not exist":"lightred","not valid":"lightred","rude":"lightred","broken":"lightred","unrecoverable":"lightred","exception":"pink","changed":"orange","deleted":"orange","interrupted":"orange","interruption":"orange","fault":"orange","fault(s)":"orange","none":"orange","removed":"orange","timeout":"orange","unaltered":"orange","unfit":"orange"}}

{arin_log-0.2.0 → arin_log-0.2.2}/arin_log/logger.py

@@ -5,21 +5,20 @@ Centrale logging-module van arin_log.
 
 Ondersteunende modules:
     folder.py   - beheert de config en de log folder.
-    utils.py    - algemene helpers (load_json, save_json).
     console.py  - console-interactie (menu, scherm wissen).
 
 Publieke functies:
     log_start, log_notes, log_except, log_exit, config_logs,
-    file_exist, tijd, not_set, last_record.
+    file_exist, tijd, cls, load_json, save_json, tas.
 """
 
-from os import path, makedirs
-from sys import _getframe, stderr, exit
+from json import load as jload, dump as jdump
+from os import makedirs, name, path, system
+from sys import _getframe, stderr
+from time import sleep, strftime
+from arin_log import folder
 from gc import collect
 from re import sub
-import time
-
-from arin_log import folder
 
 color_words = {}
 color_codes = {}
@@ -37,7 +36,13 @@ def not_set():
 
 
 def tijd():
-    return time.strftime("%H:%M:%S")
+    return strftime("%H:%M:%S")
+    
+    
+def cls():
+    """Wist het scherm. Op Windows met 'cls', anders met 'clear'."""
+    system('cls' if name == 'nt' else 'clear')
+    return
 
 
 def last_record(logloc):
@@ -104,7 +109,6 @@ def to_file(data, logloc=None):
                                 lijn = '_' * (lng - 1) + br
                             txtFile.write(lijn)
                             recs_dic[logloc] = 'ne'
-                txtFile.close()
         except Exception:
             st = ' ; '.join(['logging', fnm, 'fail'])
             log_except(frm, st, mod=prgnm, logloc=logloc)
@@ -121,7 +125,6 @@ def log_notes(notes, cons=None, logloc=None, end=False, ar_on=True):
     end=True  -> gebruik 'Arin' als prefix (voor afsluitende berichten).
     end=False -> gebruik 'Arin :' als prefix (of geen prefix als ar_on=False).
     """
-    global br, prgnm
     cons = True if cons is None else cons
     st = False if logloc is None else True
     if isinstance(notes, str):
@@ -153,7 +156,7 @@ def log_start(pnm, imp=None, cons=None, logloc=None):
     imp = False if imp is None else imp
     typ = 'pending' if imp else 'running'
     cons = True if cons is None else cons
-    tas2 = time.strftime('%y-%m-%d')
+    tas2 = strftime('%y-%m-%d')
     lijn = ' ; '.join([pnm, tijd(), typ])
     if last_record(logloc) != br:
         lijn = [br, lijn]
@@ -164,7 +167,6 @@ def log_start(pnm, imp=None, cons=None, logloc=None):
 
 
 def log_except(frm, note, mod=None, cons=None, logloc=None):
-    global br
     logloc = 'error' if logloc is None else logloc
     cons = True if cons is None else cons
     if last_record(logloc) == br:
@@ -185,7 +187,6 @@ def log_except(frm, note, mod=None, cons=None, logloc=None):
 
 
 def log_exit(prginf, imp=None, cons=None, logloc=None):
-    global br
     imp = False if imp is None else imp
     cons = True if cons is None else cons
     notes = [prginf] if isinstance(prginf, str) else prginf
@@ -197,8 +198,8 @@ def log_exit(prginf, imp=None, cons=None, logloc=None):
         notes[-1] = ' ; '.join([notes[-1], tijd(), 'terminated'])
     notes.append(br)
     log_notes(notes, logloc=logloc, cons=cons)
-    collect()
     if imp:
+        collect()
         return
     else:
         import sys
@@ -221,21 +222,24 @@ def config_logs():
 
 
 def file_exist(pf, timeout=None):
-    from time import sleep
+    """
+    Controleert of een bestand bestaat, met een maximum wachttijd.
+    Retourneert True zodra het bestand bestaat.
+    Retourneert False als het bestand na 'timeout' seconden nog
+    niet bestaat, of als 'pf' None is.
+    """
+    
     timeout = 0.24 if timeout is None else timeout
     if pf is None:
         return False
-    else:
-        st = True
-        slt = 0.08
-        tt = 0
-        while not path.isfile(pf):
-            tt = tt + slt
-            if tt >= timeout:
-                st = False
-                break
-            sleep(slt)
-    return st
+    slt = 0.08
+    tt = 0
+    while not path.isfile(pf):
+        sleep(slt)
+        tt += slt
+        if tt >= timeout:
+            return False
+    return True
 
 
 def _ensure_log_folder():
@@ -246,14 +250,56 @@ def _ensure_log_folder():
         makedirs(folder.log_folder, exist_ok=True)
     except Exception:
         stderr.write(f"log ; folder ; inexistent{br}administrator ; adjustments ; required")
-        exit(1)
+        exit(0)
     return
+    
+
+def load_json(pf, logloc=None):
+    """Leest een JSON-bestand. Retourneert {} bij ontbreken of corruptie."""
+    logloc = prgnm if logloc is None else logloc
+    jsnd = {}
+    fnm = path.basename(pf)
+    if path.isfile(pf):
+        try:
+            with open(pf, encoding='utf-8') as fil:
+                jsnd = jload(fil)
+        except Exception:
+            fcnm = _getframe().f_code.co_name
+            tmp = f"data ; {fnm} ; corrupt"
+            log_notes(tmp)
+            log_notes(f"⚠️ {tmp}", cons=False, logloc=logloc)
+            log_notes(f"⚠️ {prgnm} ; {fcnm} ; {tijd()}", cons=False, logloc=logloc)
+    else:
+        fcnm = _getframe().f_code.co_name
+        tmp = f"file ; {fnm} ; inexistent"
+        log_notes(tmp)
+        log_notes(f"⚠️ {tmp}", cons=False, logloc=logloc)
+        log_notes(f"⚠️ {prgnm} ; {fcnm} ; {tijd()}", cons=False, logloc=logloc)
+    return jsnd
+
+
+def save_json(pf, data, indent=None, logloc=None):
+    """Schrijft data als JSON. Retourneert True bij succes, anders False."""
+    logloc = prgnm if logloc is None else logloc
+    indent = indent if isinstance(indent, int) and indent >= 0 else None
+    fnm = path.basename(pf)
+    try:
+        with open(pf, 'w', encoding='utf-8') as fil:
+            jdump(data, fil, ensure_ascii=False, indent=indent)
+        return True
+    except Exception:
+        fcnm = _getframe().f_code.co_name
+        tmp = f"save ; {fnm} ; fail"
+        log_notes(tmp)
+        log_notes(f"⚠️ {tmp}", cons=False, logloc=logloc)
+        log_notes(f"⚠️ {prgnm} ; {fcnm} ; {tijd()}", cons=False, logloc=logloc)
+        return False
 
 
 if not_set():
     prgnm = path.basename(__file__).split('.')[0]
-    tas2 = time.strftime('%y-%m-%d')
-    tas = time.strftime('%Y-%m-%d')
+    tas2 = strftime('%y-%m-%d')
+    tas = strftime('%Y-%m-%d')
     _ensure_log_folder()
     config_logs()
 
@@ -262,4 +308,4 @@ if __name__ == "__main__":
     from arin_log.demo_log import demo
     demo()
     exit(0)
-
+    

{arin_log-0.2.0 → arin_log-0.2.2}/arin_log.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arin-log
-Version: 0.2.0
+Version: 0.2.2
 Summary: A lightweight logging package for long-running pipelines: a virtual assistant for the user, a clean archive for the developer.
 Author-email: Marcus Aurelius <marcus.aurelius.hu@gmail.com>
 License-Expression: MIT
@@ -115,6 +115,66 @@ my_pipeline ; 14:32:11 ; completed
 
 ---
 
+## Public API
+
+All functions and helpers below are available directly from the
+package:
+
+```python
+from arin_log import (
+    # Logger
+    log_start, log_notes, log_except, log_exit,
+    config_logs, file_exist,
+    # Helpers
+    tijd, tas, cls,
+    load_json, save_json,
+    # Folder
+    change_folder, get_folder,
+    # Console
+    cons_menu,
+)
+```
+
+| Name | Purpose |
+|------|---------|
+| `log_start` | Mark the start of a run and refresh the daily log date |
+| `log_notes` | Write notes to the console and/or the log file |
+| `log_except` | Log an exception with `module.function.line` info |
+| `log_exit` | Mark the end of a run (and optionally exit the process) |
+| `config_logs` | Load the colors from `config_log.json` |
+| `file_exist` | Check if a file exists, with an optional wait time |
+| `tijd` | Return the current time as `HH:MM:SS` |
+| `tas` | Today as string (`YYYY-MM-DD`), set at import |
+| `cls` | Clear the console (Windows: `cls`, otherwise `clear`) |
+| `load_json` | Read a JSON file, return `{}` if missing or corrupt |
+| `save_json` | Write data as JSON, return `True` or `False` |
+| `change_folder` | Open the folder dialog and update the config |
+| `get_folder` | Return the current log folder |
+| `cons_menu` | Show a console menu and return the chosen command |
+
+---
+
+## JSON helpers
+
+`arin_log` ships with two JSON helpers, available directly from the
+package:
+
+```python
+from arin_log import load_json, save_json
+
+data = load_json("myfile.json")
+save_json("myfile.json", data, indent=4)
+```
+
+`load_json` returns `{}` if the file is missing or corrupt.
+`save_json` returns `True` on success, `False` on failure.
+
+These helpers come with `arin_log` because most modules already
+import the package — so they are available wherever you need them,
+without an extra dependency.
+
+---
+
 ## What makes `arin_log` different?
 
 | Aspect | `arin_log` | Loguru / stdlib / structlog |
@@ -132,13 +192,16 @@ console and archive + Arin.
 
 ## How it works
 
-The package consists of four modules, each with a clear task:
+The package consists of three modules, each with a clear task:
 
 - **`logger.py`** — the heart: `log_start`, `log_notes`, `log_except`,
-  `log_exit`, and the helpers.
+  `log_exit`, plus the helpers `tijd`, `tas`, `cls`, `load_json`,
+  `save_json`, and `config_logs`.
 - **`folder.py`** — manages the config folder and the log folder.
-- **`console.py`** — console interaction: clear screen, menus.
-- **`utils.py`** — JSON helpers (`load_json`, `save_json`).
+- **`console.py`** — console interaction: menus.
+
+**`utils.py`** remains as an internal helper for `folder.py` only.
+It is not part of the public API.
 
 ### Configuration
 
@@ -182,4 +245,4 @@ MIT — see [LICENSE](LICENSE).
 
 ## Status
 
-**Alpha (0.2.0).** The core works. Tests are still in development.
+**Alpha (0.2.2).** The core works. Tests are still in development.

{arin_log-0.2.0 → arin_log-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "arin-log"
-version = "0.2.0"
+version = "0.2.2"
 description = "A lightweight logging package for long-running pipelines: a virtual assistant for the user, a clean archive for the developer."
 readme = "README.md"
 requires-python = ">=3.9"

arin_log-0.2.0/arin_log/log_cnfg.json

@@ -1,63 +0,0 @@
-   {
-	   "color_codes": {
-		  "black": "30m",
-		  "blue": "34m",
-		  "cyan": "36m",
-		  "darkgrey": "90m",
-		  "green": "32m",
-		  "lightblue": "94m",
-		  "lightcyan": "96m",
-		  "lightgreen": "92m",
-		  "lightgrey": "37m",
-		  "lightred": "91m",
-		  "orange": "33m",
-		  "pink": "95m",
-		  "purple": "35m",
-		  "red": "31m",
-		  "yellow": "93m"
-	   },
-	   "color_words": {
-		  "Arin": "cyan",
-		  "completed": "cyan",
-		  "modification": "cyan",
-		  "pending": "cyan",
-		  "terminated": "cyan",
-		  "satisfied": "cyan",
-		  "shutdown": "cyan",
-		  "startup": "cyan",
-          "rebooted": "cyan",
-		  "recovery": "cyan",
-		  "running": "cyan",
-		  "updated": "cyan",
-		  "added": "green",
-		  "succes": "green",
-          "success": "green",
-		  "present": "green",
-		  "restored": "green",
-		  "saved": "green",
-		  "corrupt": "lightred",
-		  "error": "lightred",
-		  "empty": "lightred",
-		  "fail": "lightred",
-		  "false": "lightred",
-		  "inexistent": "lightred",
-		  "invalid": "lightred",
-		  "not exist": "lightred",
-		  "not valid": "lightred",
-		  "rude": "lightred",
-		  "broken": "lightred",
-		  "unrecoverable": "lightred",
-		  "exception": "pink",
-		  "changed": "orange",
-		  "deleted": "orange",
-		  "interrupted": "orange",
-		  "interruption": "orange",
-		  "fault": "orange",
-          "fault(s)": "orange",
-		  "none": "orange",
-          "removed": "orange",
-		  "timeout": "orange",
-		  "unaltered": "orange",
-		  "unfit": "orange"
-	   }
-   }