matrx-utils 1.0.2__tar.gz

matrx_utils-1.0.2/.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for trusted publishing
+      contents: read
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      
+      - name: Install UV
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      
+      - name: Extract version from tag
+        id: get_version
+        run: |
+          TAG=${GITHUB_REF#refs/tags/v}
+          echo "VERSION=$TAG" >> $GITHUB_OUTPUT
+          echo "Publishing version: $TAG"
+      
+      - name: Verify version matches pyproject.toml
+        run: |
+          TOML_VERSION=$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          if [ "${{ steps.get_version.outputs.VERSION }}" != "$TOML_VERSION" ]; then
+            echo "❌ Error: Git tag version (${{ steps.get_version.outputs.VERSION }}) doesn't match pyproject.toml version ($TOML_VERSION)"
+            exit 1
+          fi
+          echo "✅ Version verified: $TOML_VERSION"
+      
+      - name: Build package
+        run: |
+          uv build
+      
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          print-hash: true
+

matrx_utils-1.0.2/.gitignore

@@ -0,0 +1,209 @@
+# 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/
+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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the enitre vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+.idea/
+
+
+# Ignore all files in any temp directory and all subdirectories (unlimited depth)
+**/temp/**/*
+
+# But allow all directories in any temp folder and all subdirectories (unlimited depth)
+!**/temp/**/
+
+.history*
+.history/
+local_data/
+_dev/
+/_dev/

matrx_utils-1.0.2/.python-version

@@ -0,0 +1 @@
+3.13

matrx_utils-1.0.2/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: matrx-utils
+Version: 1.0.2
+Summary: Basic utilities for matrx
+Author-email: jatin.b.rx3@gmail.com
+Requires-Python: >=3.10
+Requires-Dist: dotenv>=0.9.9
+Requires-Dist: inflect>=7.5.0
+Requires-Dist: pillow>=11.2.1
+Requires-Dist: requests>=2.32.5
+Description-Content-Type: text/markdown
+
+# matrx-utils
+
+A comprehensive collection of Python utilities designed to complement the AI Matrx platform.
+
+## Overview
+
+matrx-utils provides a curated set of utility functions and tools that enhance the AI Matrx ecosystem. This repository serves as a centralized library of commonly used functionality, allowing for easy integration across the main AI Matrx application and related projects.
+
+## Features
+
+- **Logging utilities** - Enhanced logging capabilities
+- **Print utilities** - Advanced printing and formatting tools
+- **Code analysis** - Tools for analyzing and processing code
+- **Markdown processing** - Utilities for working with markdown content
+- **Object manipulation** - Helper functions for working with Python objects
+- **Data conversion** - Tools for converting between different data formats
+- **Additional utilities** - Various other Python utility-level tools
+
+## Purpose
+
+This library is designed to provide instant access to a powerful set of utilities without requiring additional code setup. All utilities have been customized and configured specifically for the AI Matrx platform ecosystem.
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install matrx-utils
+# or with uv
+uv add matrx-utils
+```
+
+### From GitHub (for development)
+
+```bash
+pip install git+https://github.com/armanisadeghi/matrx-utils.git
+```
+
+## Quick Start
+
+```python
+import matrx_utils
+
+# Example usage will be added as the library develops
+```
+
+## Contributing
+
+This project is part of the AI Matrx ecosystem. Contributions and suggestions are welcome.
+
+## License
+
+[License information to be added]
+
+## Related Projects
+
+- [AI Matrx](https://github.com/armanisadeghi/ai-matrx) - Main AI Matrx platform repository
+
+
+## Publishing a New Version
+
+### Automated PyPI Publishing (Current Process)
+
+The package automatically publishes to PyPI when you push a version tag. Here's the workflow:
+
+1. **Make and test your changes locally**
+   ```bash
+   # Test your changes
+   ```
+
+2. **Update the version in pyproject.toml**
+   ```toml
+   version = "1.0.3"  # Increment appropriately
+   ```
+
+3. **Commit and push changes**
+   ```bash
+   git add .
+   git commit -m "Add new feature - v1.0.3"
+   git push origin main
+   ```
+
+4. **Create and push the version tag**
+   ```bash
+   git tag v1.0.3
+   git push origin v1.0.3
+   ```
+
+5. **GitHub Actions automatically:**
+   - Verifies the tag matches pyproject.toml version
+   - Builds the package
+   - Publishes to PyPI
+
+6. **Update dependent projects**
+   
+   In projects like AI Dream, simply update the version:
+   ```bash
+   uv add matrx-utils@1.0.3
+   # or manually in pyproject.toml:
+   # matrx-utils = "^1.0.3"
+   ```
+
+### Version History
+
+Check current tags: `git tag`
+
+Example output:
+```
+v1.0.0
+v1.0.1
+v1.0.2
+```
+
+### Important Notes
+
+- **Always update pyproject.toml version before tagging**
+- The GitHub Action will fail if tag version ≠ pyproject.toml version
+- Semantic versioning: MAJOR.MINOR.PATCH (e.g., v1.0.3)
+- Tags trigger automatic PyPI publishing

matrx_utils-1.0.2/README.md

@@ -0,0 +1,119 @@
+# matrx-utils
+
+A comprehensive collection of Python utilities designed to complement the AI Matrx platform.
+
+## Overview
+
+matrx-utils provides a curated set of utility functions and tools that enhance the AI Matrx ecosystem. This repository serves as a centralized library of commonly used functionality, allowing for easy integration across the main AI Matrx application and related projects.
+
+## Features
+
+- **Logging utilities** - Enhanced logging capabilities
+- **Print utilities** - Advanced printing and formatting tools
+- **Code analysis** - Tools for analyzing and processing code
+- **Markdown processing** - Utilities for working with markdown content
+- **Object manipulation** - Helper functions for working with Python objects
+- **Data conversion** - Tools for converting between different data formats
+- **Additional utilities** - Various other Python utility-level tools
+
+## Purpose
+
+This library is designed to provide instant access to a powerful set of utilities without requiring additional code setup. All utilities have been customized and configured specifically for the AI Matrx platform ecosystem.
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install matrx-utils
+# or with uv
+uv add matrx-utils
+```
+
+### From GitHub (for development)
+
+```bash
+pip install git+https://github.com/armanisadeghi/matrx-utils.git
+```
+
+## Quick Start
+
+```python
+import matrx_utils
+
+# Example usage will be added as the library develops
+```
+
+## Contributing
+
+This project is part of the AI Matrx ecosystem. Contributions and suggestions are welcome.
+
+## License
+
+[License information to be added]
+
+## Related Projects
+
+- [AI Matrx](https://github.com/armanisadeghi/ai-matrx) - Main AI Matrx platform repository
+
+
+## Publishing a New Version
+
+### Automated PyPI Publishing (Current Process)
+
+The package automatically publishes to PyPI when you push a version tag. Here's the workflow:
+
+1. **Make and test your changes locally**
+   ```bash
+   # Test your changes
+   ```
+
+2. **Update the version in pyproject.toml**
+   ```toml
+   version = "1.0.3"  # Increment appropriately
+   ```
+
+3. **Commit and push changes**
+   ```bash
+   git add .
+   git commit -m "Add new feature - v1.0.3"
+   git push origin main
+   ```
+
+4. **Create and push the version tag**
+   ```bash
+   git tag v1.0.3
+   git push origin v1.0.3
+   ```
+
+5. **GitHub Actions automatically:**
+   - Verifies the tag matches pyproject.toml version
+   - Builds the package
+   - Publishes to PyPI
+
+6. **Update dependent projects**
+   
+   In projects like AI Dream, simply update the version:
+   ```bash
+   uv add matrx-utils@1.0.3
+   # or manually in pyproject.toml:
+   # matrx-utils = "^1.0.3"
+   ```
+
+### Version History
+
+Check current tags: `git tag`
+
+Example output:
+```
+v1.0.0
+v1.0.1
+v1.0.2
+```
+
+### Important Notes
+
+- **Always update pyproject.toml version before tagging**
+- The GitHub Action will fail if tag version ≠ pyproject.toml version
+- Semantic versioning: MAJOR.MINOR.PATCH (e.g., v1.0.3)
+- Tags trigger automatic PyPI publishing

matrx_utils-1.0.2/main.py

@@ -0,0 +1,5 @@
+from matrx_utils import vcprint, clear_terminal
+
+clear_terminal()
+
+vcprint("Hello, World!", color="yellow")

matrx_utils-1.0.2/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "matrx-utils"
+version = "1.0.2"
+description = "Basic utilities for matrx"
+readme = "README.md"
+authors = [
+    { email = "jatin.b.rx3@gmail.com" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "dotenv>=0.9.9",
+    "inflect>=7.5.0",
+    "pillow>=11.2.1",
+    "requests>=2.32.5",
+]
+
+[project.scripts]
+matrx-utils = "matrx_utils:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/matrx_utils"]
+

matrx_utils-1.0.2/src/matrx_utils/__init__.py

@@ -0,0 +1,10 @@
+from .fancy_prints import vclist, vcprint, pretty_print, print_link, print_truncated, redact_object, redact_string
+from .fancy_prints.matrx_print_logger import MatrixPrintLog
+from .data_handling import DataTransformer
+from .data_handling.validation.validators import URLValidator, validate_url, validate_email
+from .utils import generate_directory_structure, generate_and_save_directory_structure, clear_terminal 
+from .file_handling import FileManager, open_any_file
+from .conf import settings, configure_settings, _restricted_task_and_definitions as RESTRICTED_TASK_AND_DEFINITIONS, _restricted_env_vars as RESTRICTED_ENV_VAR_NAMES, _restricted_service_names as RESTRICTED_SERVICE_NAMES, _restricted_fields_names as RESTRICTED_FIELD_NAMES
+
+__all__ = ["vclist", "vcprint", "pretty_print", "print_link", "print_truncated", "MatrixPrintLog", "DataTransformer", "URLValidator", "validate_url", "validate_email", "generate_directory_structure", "generate_and_save_directory_structure", "clear_terminal", "FileManager", "configure_settings", "settings"
+           ,"RESTRICTED_SERVICE_NAMES", "RESTRICTED_ENV_VAR_NAMES", "RESTRICTED_TASK_AND_DEFINITIONS", "RESTRICTED_FIELD_NAMES", "redact_object", "redact_string", "open_any_file"]