stdl 0.6.1__tar.gz → 0.6.3__tar.gz

stdl-0.6.3/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.yaml, *.yml}]
+indent_size = 2

stdl-0.6.3/.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: Lint
+on: [push, pull_request]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Set up Python
+        run: uv python install 3.12
+      - name: Install dependencies
+        run: uv sync --extra dev
+      - name: Run ruff
+        run: uv run ruff check .
+      - name: Run black
+        run: uv run black --check .

stdl-0.6.3/.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+name: Upload Python Package
+on:
+  release:
+    types: [published]
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Set up Python
+        run: uv python install 3.12
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TOKEN }}
+        run: |
+          uv build
+          uv run --with twine twine upload dist/*

stdl-0.6.3/.github/workflows/tests.yml

@@ -0,0 +1,26 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [
+          "3.10",
+          "3.11",
+          "3.12",
+          "3.13"
+        ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync --extra test --python ${{ matrix.python-version }}
+
+      - name: Run pytest
+        run: uv run --python ${{ matrix.python-version }} pytest -v

stdl-0.6.3/.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.vscode
+.idea
+
+*example*.py
+*ruff_cache*

stdl-0.6.3/.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

stdl-0.6.3/.python-version

@@ -0,0 +1 @@
+3.12

stdl-0.6.3/.readthedocs.yml

@@ -0,0 +1,31 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+# sphinx:
+#   configuration: docs/conf.py
+
+# Python environment
+python:
+  install:
+    # these are needed, because they are not part of standard setup
+    - requirements: docs/requirements.txt
+
+# Build documentation with MkDocs
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: false
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all

stdl-0.6.3/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Development
+
+## Environment
+
+For local development, you need Python 3.10 or later installed.
+We use [uv](https://docs.astral.sh/uv/) for project management, [Hatch](https://hatch.pypa.io/latest/) for environment management, and [just](https://github.com/casey/just) as our command runner.
+
+## Dependencies
+
+To install this package and its development dependencies, run:
+
+```sh
+just dev
+```
+
+or
+
+```sh
+uv sync --extra dev
+```
+
+## Code checking
+
+To execute all code checking tools together, run:
+
+```sh
+just check
+```
+
+### Linting
+
+We utilize [ruff](https://docs.astral.sh/ruff/) for linting, which analyzes code for potential issues and enforces consistent style. Refer to `pyproject.toml` for configuration details.
+
+To run linting:
+
+```sh
+just lint
+```
+
+### Formatting
+
+[ruff](https://docs.astral.sh/ruff/) is also used for code formatting. Refer to `pyproject.toml` for configuration details.
+
+To run formatting:
+
+```sh
+just format
+```
+
+## Testing
+
+We use [pytest](https://docs.pytest.org/en/stable/) for testing. You have two options for running tests:
+
+```sh
+# Run tests on your current Python version
+uv run --extra test pytest -v
+
+# Run tests across all supported Python versions
+just test
+```
+
+## Pre-commit Hooks
+
+We use [pre-commit](https://pre-commit.com/) to run quality checks automatically:
+
+```sh
+# Install pre-commit hooks
+uv tool install pre-commit
+pre-commit install
+
+# Run hooks manually on all files
+pre-commit run --all-files
+```
+
+## Documentation
+
+We follow the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for code documentation. All user-facing classes and functions must be documented with docstrings and type hints.
+
+## Release Process
+
+New versions are automatically published to [PyPI](https://pypi.org/project/stdl/) when a GitHub release is created.

stdl-0.6.3/Justfile

@@ -0,0 +1,41 @@
+@_:
+   just --list
+
+_require-uv:
+   @uv --version > /dev/null || (echo "Please install uv: https://docs.astral.sh/uv/" && exit 1)
+
+_require-hatch:
+  @hatch --version > /dev/null || (echo "Please install hatch: uv tool install hatch" && exit 1)
+
+# check code style and potential issues
+lint:
+   ruff check
+
+# fix automatically fixable linting issues
+fix:
+   ruff check --fix
+
+# format code
+format:
+   ruff format
+
+# run tests across all supported Python versions
+test: _require-hatch
+   hatch run test:test
+
+# run all quality checks
+check: format lint test
+
+# build the package
+build: _require-uv
+   uv build
+
+# setup development environment
+dev: _require-uv
+   uv sync --extra dev
+   uv run pre-commit install
+
+# clean build artifacts and caches
+clean:
+   rm -rf .venv .pytest_cache .mypy_cache .ruff_cache
+   find . -type d -name "__pycache__" -exec rm -r {} +

stdl-0.6.3/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: stdl
+Version: 0.6.3
+Summary: Extended Python Standard Library
+Project-URL: Repository, https://github.com/zigai/stdl
+Project-URL: Documentation, https://stdl.readthedocs.io
+Project-URL: Issues, https://github.com/zigai/stdl/issues
+Project-URL: Homepage, https://github.com/zigai/stdl
+Author-email: Žiga Ivanšek <ziga.ivansek@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2022 Žiga Ivanšek
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: ANSI colors,color formats,filesystem,lazy import,list utils,logging configuration,python lazy import,python utilites,standard library,stdl,string utils,terminal links,terminal output
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: toml>=0.10.2
+Requires-Dist: tqdm>=4.67.1
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: mkdocs; extra == 'dev'
+Requires-Dist: mkdocs-autorefs; extra == 'dev'
+Requires-Dist: mkdocs-material; extra == 'dev'
+Requires-Dist: mkdocstrings[python]; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# 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.
+
+## Features
+
+- File and directory operations
+- String manipulation
+- ANSI color support for terminal output
+- Date and time formatting
+- List utils
+- Lazy imports
+- Logging configuration for `logging` and `loguru`
+- [See docs](https://stdl.readthedocs.io/en/latest/?badge=latest)
+
+## Installation
+
+### Using pip
+
+```sh
+pip install stdl
+```
+
+### Using uv
+
+```sh
+uv add stdl
+```
+
+### From source
+
+```sh
+pip install git+https://github.com/zigai/stdl.git
+# or
+uv add git+https://github.com/zigai/stdl.git
+```
+
+## Examples
+
+### Lazy imports
+
+```python
+from typing import TYPE_CHECKING
+from stdl.import_lazy import import_lazy
+
+if TYPE_CHECKING:
+    from os.path import abspath, join
+    import numpy as np
+    import torch
+else:
+    import_lazy("os.path", ["join", "abspath"], verbose=True)
+    import_lazy("numpy", alias="np", verbose=True)
+    import_lazy("torch", verbose=True)
+
+print(np.zeros(4))
+# importing "numpy" took 0.060s
+# [0. 0. 0. 0.]
+print(torch)
+# <LazyImport: torch>
+print(torch.randn(8))
+# importing "torch" took 1.118s
+# tensor([0., 0., 0., 0., 0., 0., 0., 0.])
+print(torch)
+# <module 'torch' from .../torch/__init__.py'
+```
+
+## License
+
+[MIT License](https://github.com/zigai/stdl/blob/master/LICENSE)

stdl-0.6.3/README.md

@@ -0,0 +1,76 @@
+# 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.
+
+## Features
+
+- File and directory operations
+- String manipulation
+- ANSI color support for terminal output
+- Date and time formatting
+- List utils
+- Lazy imports
+- Logging configuration for `logging` and `loguru`
+- [See docs](https://stdl.readthedocs.io/en/latest/?badge=latest)
+
+## Installation
+
+### Using pip
+
+```sh
+pip install stdl
+```
+
+### Using uv
+
+```sh
+uv add stdl
+```
+
+### From source
+
+```sh
+pip install git+https://github.com/zigai/stdl.git
+# or
+uv add git+https://github.com/zigai/stdl.git
+```
+
+## Examples
+
+### Lazy imports
+
+```python
+from typing import TYPE_CHECKING
+from stdl.import_lazy import import_lazy
+
+if TYPE_CHECKING:
+    from os.path import abspath, join
+    import numpy as np
+    import torch
+else:
+    import_lazy("os.path", ["join", "abspath"], verbose=True)
+    import_lazy("numpy", alias="np", verbose=True)
+    import_lazy("torch", verbose=True)
+
+print(np.zeros(4))
+# importing "numpy" took 0.060s
+# [0. 0. 0. 0.]
+print(torch)
+# <LazyImport: torch>
+print(torch.randn(8))
+# importing "torch" took 1.118s
+# tensor([0., 0., 0., 0., 0., 0., 0., 0.])
+print(torch)
+# <module 'torch' from .../torch/__init__.py'
+```
+
+## License
+
+[MIT License](https://github.com/zigai/stdl/blob/master/LICENSE)

stdl-0.6.3/docs/reference/color.md

@@ -0,0 +1 @@
+::: stdl.color

stdl-0.6.3/docs/reference/decorators.md

@@ -0,0 +1 @@
+::: stdl.decorators

stdl-0.6.3/docs/reference/dt.md

@@ -0,0 +1 @@
+::: stdl.dt

stdl-0.6.3/docs/reference/fs.md

@@ -0,0 +1 @@
+::: stdl.fs

stdl-0.6.3/docs/reference/import_lazy.md

@@ -0,0 +1 @@
+::: stdl.import_lazy

stdl-0.6.3/docs/reference/log.md

@@ -0,0 +1 @@
+::: stdl.log

stdl-0.6.3/docs/reference/net.md

@@ -0,0 +1 @@
+::: stdl.net

stdl-0.6.3/docs/reference/st.md

@@ -0,0 +1 @@
+::: stdl.st

stdl-0.6.3/docs/requirements.txt

@@ -0,0 +1,4 @@
+mkdocs
+mkdocs-material
+mkdocs-autorefs
+mkdocstrings[python]