stdl 0.5.1__tar.gz → 0.5.3__tar.gz

{stdl-0.5.1/stdl.egg-info → stdl-0.5.3}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.1
 Name: stdl
-Version: 0.5.1
+Version: 0.5.3
 Summary: Extended Python Standard Library
 Author-email: Žiga Ivanšek <ziga.ivansek@gmail.com>
 Project-URL: Repository, https://github.com/zigai/stdl
-Keywords: python utilites,filesystem,string manipulation,logging configuration,list utils,standard library
+Project-URL: Documentation, https://stdl.readthedocs.io
+Keywords: python utilites,filesystem,string manipulation,logging configuration,list utils,standard library,ANSI colors,terminal output
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -19,23 +20,46 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML>=6.0
 Requires-Dist: tqdm
-Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: toml>=0.10.2
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocs-autorefs; extra == "dev"
+Requires-Dist: mkdocstrings[python]; extra == "dev"
 
 # stdl
 [![Tests](https://github.com/zigai/stdl/actions/workflows/tests.yml/badge.svg)](https://github.com/zigai/stdl/actions/workflows/tests.yml)
+[![Documentation Status](https://readthedocs.org/projects/stdl/badge/?version=latest)](https://stdl.readthedocs.io/en/latest/?badge=latest)
 [![PyPI version](https://badge.fury.io/py/stdl.svg)](https://badge.fury.io/py/stdl)
 ![Supported versions](https://img.shields.io/badge/python-3.10+-blue.svg)
 [![Downloads](https://static.pepy.tech/badge/stdl)](https://pepy.tech/project/stdl)
 [![license](https://img.shields.io/github/license/zigai/stdl.svg)](https://github.com/zigai/stdl/blob/master/LICENSE)
 
-Extended Python standard library.
-# Installation
+`stdl` is a collection of Python utilities that complement the standard library. It provides common functions and tools that developers frequently need, with minimal external dependencies.
+
+## Features
+- File and directory operations
+- String manipulation
+- ANSI color support for terminal output
+- Date and time formatting
+- List processing
+- Function decorators
+- Logging configuration for `logging` and `loguru`
+- [See docs](https://stdl.readthedocs.io/en/latest/?badge=latest)
+
+## Dependencies
+- PyYAML
+- python-dateutil
+- toml
+- tqdm
+
+## Installation
 
 #### Using pip
 ```
@@ -45,5 +69,5 @@ pip install stdl
 ```
 pip install git+https://github.com/zigai/stdl
 ```
-# License
+## License
 [MIT License](https://github.com/zigai/stdl/blob/master/LICENSE)

stdl-0.5.3/README.md

@@ -0,0 +1,38 @@
+# stdl
+[![Tests](https://github.com/zigai/stdl/actions/workflows/tests.yml/badge.svg)](https://github.com/zigai/stdl/actions/workflows/tests.yml)
+[![Documentation Status](https://readthedocs.org/projects/stdl/badge/?version=latest)](https://stdl.readthedocs.io/en/latest/?badge=latest)
+[![PyPI version](https://badge.fury.io/py/stdl.svg)](https://badge.fury.io/py/stdl)
+![Supported versions](https://img.shields.io/badge/python-3.10+-blue.svg)
+[![Downloads](https://static.pepy.tech/badge/stdl)](https://pepy.tech/project/stdl)
+[![license](https://img.shields.io/github/license/zigai/stdl.svg)](https://github.com/zigai/stdl/blob/master/LICENSE)
+
+`stdl` is a collection of Python utilities that complement the standard library. It provides common functions and tools that developers frequently need, with minimal external dependencies.
+
+## Features
+- File and directory operations
+- String manipulation
+- ANSI color support for terminal output
+- Date and time formatting
+- List processing
+- Function decorators
+- Logging configuration for `logging` and `loguru`
+- [See docs](https://stdl.readthedocs.io/en/latest/?badge=latest)
+
+## Dependencies
+- PyYAML
+- python-dateutil
+- toml
+- tqdm
+
+## Installation
+
+#### Using pip
+```
+pip install stdl
+```
+#### From source
+```
+pip install git+https://github.com/zigai/stdl
+```
+## License
+[MIT License](https://github.com/zigai/stdl/blob/master/LICENSE)

{stdl-0.5.1 → stdl-0.5.3}/pyproject.toml

@@ -1,12 +1,18 @@
 [project]
 name = "stdl"
-version = "0.5.1"
+version = "0.5.3"
 description = "Extended Python Standard Library"
 authors = [{ name = "Žiga Ivanšek", email = "ziga.ivansek@gmail.com" }]
 license = { file = "LICENSE.txt" }
 readme = "README.md"
 requires-python = ">=3.10"
-dependencies = ["PyYAML>=6.0", "tqdm", "python-dateutil==2.8.2"]
+
+dependencies = [
+    "PyYAML>=6.0",
+    "tqdm",
+    "python-dateutil>=2.8.2",
+    "toml>=0.10.2 ",
+]
 
 classifiers = [
     "Intended Audience :: Developers",
@@ -27,15 +33,26 @@ keywords = [
     "logging configuration",
     "list utils",
     "standard library",
+    "ANSI colors",
+    "terminal output",
 ]
 
 
 [project.optional-dependencies]
 test = ["pytest"]
-dev = ["black", "pytest", "ruff"]
+dev = [
+    "black",
+    "pytest",
+    "ruff",
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocs-autorefs",
+    "mkdocstrings[python]",
+]
 
 [project.urls]
 Repository = "https://github.com/zigai/stdl"
+Documentation = "https://stdl.readthedocs.io"
 
 [tool.black]
 line-length = 100

stdl-0.5.3/stdl/__init__.py

@@ -0,0 +1 @@
+from stdl import dt, fs, log, lst, net, st

{stdl-0.5.1 → stdl-0.5.3}/stdl/decorators.py

@@ -2,13 +2,13 @@ import inspect
 import json
 import sys
 import time
+import typing as T
 from functools import wraps
-from typing import Callable
 
 
 def timer(
     r: int | None = 2,
-    sink: Callable = sys.stdout.write,
+    sink: T.Callable = sys.stdout.write,
     show_args: bool = False,
     serialize: bool = False,
     sep=" | ",
@@ -24,7 +24,7 @@ def timer(
         sep (str, optional): Separator between the function/method name and the arguments. Defaults to " | ".
     """
 
-    def decorator(func: Callable):
+    def decorator(func: T.Callable):
         @wraps(func)
         def wrapper(*args, **kwargs):
             time_start = time.perf_counter()
@@ -84,3 +84,6 @@ def retry(attempts: int, delay: float = 0):
         return wrapper
 
     return decorator
+
+
+__all__ = ["timer", "retry"]

{stdl-0.5.1 → stdl-0.5.3}/stdl/dt.py

@@ -1,8 +1,8 @@
 import random
 import time
+import typing as T
 from dataclasses import dataclass
 from datetime import date, datetime, timedelta, timezone
-from typing import Generator
 
 from dateutil.parser import parse as parse_datetime_str
 
@@ -40,12 +40,12 @@ class Timer:
         Stop the timer.
 
         Args:
-            label (str | None, optional): Label for the stop. Defaults to None.
+            label (str | None, optional): Label for the stop.
 
         Returns:
             TimerStop: The stop data
         """
-        t = time.time()
+        t = time.perf_counter()
         elapsed_total = t - self.start
         since_last = t - self.stops[-1].at if self.stops else 0
         if not self.ms:
@@ -78,7 +78,7 @@ class Timer:
 
     def reset(self) -> None:
         """Reset the timer."""
-        self.start = time.time()
+        self.start = time.perf_counter()
         self.stops: list[TimerStop] = [
             TimerStop(
                 total=timedelta(seconds=0),
@@ -88,10 +88,6 @@ class Timer:
             )
         ]
 
-    def print_stops(self) -> None:
-        for stop in self.stops:
-            print(stop)
-
 
 def datetime_fmt(
     d: str | float | int | None | datetime = None,
@@ -105,12 +101,12 @@ def datetime_fmt(
     """Format date and time
 
     Args:
-        d (str | float | None | datetime, optional): Input datetime. Defaults to None.
-        fmt (str, optional): Date format. Defaults to "Ymd".
-        dsep (str, optional): Date values separator. Defaults to "-".
-        tsep (str, optional): Time values separator. Defaults to ":".
-        ms (bool, optional): include miliseconds. Defaults to False.
-        utc (bool, optional):  Use the UTC timezone when building a datetime object from a timestamp. Defaults to True.
+        d (str | float | None | datetime, optional): Input datetime. Defaults to current date and time.
+        fmt (str, optional): Date format.
+        dsep (str, optional): Date values separator.
+        tsep (str, optional): Time values separator.
+        ms (bool, optional): include miliseconds.
+        utc (bool, optional):  Use the UTC timezone when building a datetime object from a timestamp.
 
     Raises:
         TypeError: Raises TypeError if the type of ``d`` is not one of the following: float, str, None, datetime, int
@@ -118,17 +114,18 @@ def datetime_fmt(
     Returns:
         str: Formated date and time.
 
-    Examples:
-    --------
-    >>> fmt_datetime()
-    '2022-11-22 22:40:04' # current date and time
-    >>> fmt_datetime(0)
-    "1970-01-01 00:00:00"
-    >>> fmt_datetime(0, fmt="dmY", dsep="/")
-    "01/01/1970 00:00:00"
+    Example:
+        ```python
+        >>> fmt_datetime()
+        '2022-11-22 22:40:04' # current date and time
+        >>> fmt_datetime(0)
+        "1970-01-01 00:00:00"
+        >>> fmt_datetime(0, fmt="dmY", dsep="/")
+        "01/01/1970 00:00:00"
+        ```
     """
     if d is None:
-        d = datetime.fromtimestamp(time.time(), **{"tz": timezone.utc} if utc else {})
+        d = datetime.fromtimestamp(time.perf_counter(), **{"tz": timezone.utc} if utc else {})
 
     elif isinstance(d, str):
         d = parse_datetime_str(d)
@@ -153,10 +150,10 @@ def time_fmt(
     Format time
 
     Args:
-        t (float | datetime | int | None, optional): Input time. Defaults to current time if it's not provided.
-        sep (str, optional): Character(s) that separates hours, minutes, seconds... Defaults to ":".
-        ms (bool, optional): include miliseconds. Defaults to False.
-        utc (bool, optional): Use the UTC timezone when building a time object from a timestamp. Defaults to True.
+        t (float | datetime | int | None, optional): Input time. Defaults to current time.
+        sep (str, optional): Character(s) that separates hours, minutes, seconds...
+        ms (bool, optional): include miliseconds.
+        utc (bool, optional): Use the UTC timezone when building a time object from a timestamp.
 
     Raises:
         TypeError: Raises TypeError if the type of ``t`` is not one of the following: float, None, datetime, int
@@ -165,7 +162,7 @@ def time_fmt(
         str: Formated time.
     """
     if t is None:
-        tm = datetime.fromtimestamp(time.time(), **{"tz": timezone.utc} if utc else {})
+        tm = datetime.fromtimestamp(time.perf_counter(), **{"tz": timezone.utc} if utc else {})
     elif isinstance(t, datetime):
         tm = t.time()
     elif isinstance(t, (int, float)):
@@ -188,9 +185,9 @@ def date_fmt(
     Format date
 
     Args:
-        d (float | date | datetime | int | None ): Input date. Defaults to current date if it's not provided.
-        fmt (str, optional): Date format. Defaults to "Ymd".
-        sep (str, optional): Character(s) that separates days, months and years. Defaults to "-".
+        d (float | date | datetime | int | None ): Input date. Defaults to current date.
+        fmt (str, optional): Date format.
+        sep (str, optional): Character(s) that separates days, months and years.
 
     Raises:
         TypeError: Raises TypeError if the type of ``d`` is not one of the following: float, None, date, datetime, int
@@ -198,19 +195,20 @@ def date_fmt(
     Returns:
         str: Formated date.
 
-    Examples
-    --------
-    >>> fmt_date(date(2022,11,22))
-    '2022-11-22'
-    >>> fmt_date(date(2022,11,22), sep="/")
-    '2022/11/22'
-    >>> fmt_date(date(2022,11,22), sep="/", fmt="dmY")
-    '22/11/2022'
-    >>> fmt_date()
-    '2022-11-22'
+    Example:
+        ```python
+        >>> fmt_date(date(2022,11,22))
+        '2022-11-22'
+        >>> fmt_date(date(2022,11,22), sep="/")
+        '2022/11/22'
+        >>> fmt_date(date(2022,11,22), sep="/", fmt="dmY")
+        '22/11/2022'
+        >>> fmt_date()
+        '2022-11-22'
+        ```
     """
     if d is None:
-        d = date.fromtimestamp(time.time())
+        d = date.fromtimestamp(time.perf_counter())
     elif isinstance(d, (float, int)):
         d = date.fromtimestamp(d)
     elif isinstance(d, datetime):
@@ -222,16 +220,17 @@ def date_fmt(
     return d.strftime(f"%{fmt[0]}{sep}%{fmt[1]}{sep}%{fmt[2]}")
 
 
-def date_range(start: date, end: date) -> Generator[date, None, None]:
+def date_range(start: date, end: date) -> T.Generator[date, None, None]:
     """
     Returns a generator for dates between ``start`` and ``end``
 
-    Examples
-    --------
-    >>> for i in date_range(date(2022,11,19), date(2022,11,22)): print(i)
-    2022-11-19
-    2022-11-20
-    2022-11-21
+    Example:
+        ```python
+        >>> for i in date_range(date(2022,11,19), date(2022,11,22)): print(i)
+        2022-11-19
+        2022-11-20
+        2022-11-21
+        ```
     """
     for n in range(int((end - start).days)):
         yield start + timedelta(n)