pylogshield 0.0.1__tar.gz

pylogshield-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,116 @@
+# ==============================================================================
+# 🚢 Release Workflow — Project Caller
+# ==============================================================================
+# Save this file in YOUR PROJECT repo at:
+#   .github/workflows/release.yml
+#
+# TRIGGERS & JOB MATRIX:
+#
+#   Event            │ docs │ publish
+#   ─────────────────┼──────┼────────
+#   Push to main     │  ✅  │   ⛔
+#   Push tag X.X.X   │  ⛔  │   ✅
+#   Manual dispatch  │  ✅  │   ⛔
+#
+# PUBLISH TARGET FLAG (controls where the package is published):
+#
+#   publish-target: 'both'     → TestPyPI first, then PyPI  ← default
+#   publish-target: 'pypi'     → PyPI only
+#   publish-target: 'testpypi' → TestPyPI only
+#
+# RELEASE FLOW:
+#   1. Merge PRs to main as normal — docs deploy automatically
+#   2. When ready to release, push a bare SemVer tag:
+#        git tag 1.2.1
+#        git push origin 1.2.1
+#   3. The publish job runs: validate → test → build → testpypi → pypi
+#
+# SECRETS REQUIRED (Settings → Secrets and variables → Actions):
+#   TEST_PYPI_API_TOKEN  — from test.pypi.org/manage/account/token/
+#   PYPI_API_TOKEN       — from pypi.org (only if not using Trusted Publishing)
+#
+# PRE-REQUISITES (once per project):
+#
+#   1. Enable GitHub Pages:
+#      Settings → Pages → Source → GitHub Actions
+#
+#   2. Create GitHub Environments:
+#      Settings → Environments → New environment
+#        - "pypi"      (real PyPI — add Required reviewers for safety)
+#        - "test-pypi" (TestPyPI sandbox — no reviewers needed)
+#
+#   3. Register Trusted Publisher on pypi.org:
+#      pypi.org → your project → Publishing → Add publisher
+#        owner    = vertex-ai-automations
+#        repo     = THIS-REPO-NAME
+#        workflow = release.yml
+#        env      = pypi
+#
+#   4. Create docs/requirements.txt:
+#        mkdocs-material==9.5.18
+#        mkdocstrings[python]==0.24.3
+#
+# CUSTOMISE PER PROJECT:
+#   python-version   — match your project's Python version
+#   test-command     — your test runner command
+#   publish-target   — 'both' | 'pypi' | 'testpypi'
+#   src-layout       — true if you use a src/ directory layout
+#   mkdocs-strict    — false to allow doc build warnings
+# ==============================================================================
+
+name: 🚢 Release
+
+on:
+  push:
+    branches:
+      - main          # Docs deploy only
+    tags:
+      - "*.*.*"       # Publish only — bare SemVer e.g. 1.2.1
+  workflow_dispatch:  # Manual trigger — docs only
+
+jobs:
+
+  # ============================================================
+  # 📚 Deploy MkDocs to GitHub Pages
+  # Runs on: push to main, manual dispatch
+  # ============================================================
+  docs:
+    name: 📚 Deploy Docs
+    uses: vertex-ai-automations/shared-workflows/.github/workflows/publish-mkdocs.yml@main
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    with:
+      python-version: "3.11"
+      docs-requirements: "docs/requirements.txt"
+      src-layout: true       # ← set false if not using src/ layout
+      mkdocs-strict: true    # ← set false to allow doc build warnings
+    secrets: inherit
+
+  # ============================================================
+  # 📦 Build and Publish Package
+  # Runs on: tag push only (tag guard is enforced inside the
+  # reusable workflow — non-tag pushes skip cleanly)
+  #
+  # publish-target controls which registries receive the package:
+  #   'both'     → TestPyPI first, then PyPI (recommended)
+  #   'pypi'     → PyPI only
+  #   'testpypi' → TestPyPI only
+  #
+  # No permissions block needed — declared inside python-publish.yml
+  # ============================================================
+  publish:
+    name: 📦 Publish Package
+    uses: vertex-ai-automations/shared-workflows/.github/workflows/python-publish.yml@main
+    permissions:
+      contents: read
+      id-token: write
+    with:
+      python-version: "3.11"
+      run-tests: true
+      test-command: "pytest tests/ -v --tb=short"
+      publish-target: "pypi"          # 'both' | 'pypi' | 'testpypi'
+      use-trusted-publishing: false    # set false to use PYPI_API_TOKEN instead
+    secrets: inherit
+

pylogshield-0.0.1/.gitignore

@@ -0,0 +1,189 @@
+# Derived from basic .gitignore template for python projects:
+#   https://github.com/github/gitignore/blob/main/Python.gitignore
+# Please maintain the alphabetic order of the section titles
+# To debug why a file is being ignored, use the command:
+#    git check-ignore -v $my_ignored_file
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Cython debug symbols
+cython_debug/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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
+
+# Django stuff
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Flask stuff
+instance/
+.webassets-cache
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Jupyter Notebook
+*.ipynb_checkpoints
+
+# mkdocs documentation
+/site
+
+# Model saving / checkpointing
+*.pt
+*.pth
+*.ckpt
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# PyBuilder
+.pybuilder/
+target/
+
+# 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/
+
+# 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
+
+# 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
+
+# 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
+
+# PEP 582: https://peps.python.org/pep-0582/
+#   This PEP proposes to add to Python a mechanism to automatically recognize a __pypackages__
+#   directory and prefer importing packages installed in this location over user or global site-packages.
+#   This will avoid the steps to create, activate or deactivate virtual environments. Python will use
+#   the __pypackages__ from the base directory of the script when present.
+__pypackages__/
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Rope project settings
+.ropeproject
+
+# SageMath parsed files
+*.sage.py
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/build
+# sphinx-gallery
+docs/source/generated_examples/
+docs/source/gen_modules/
+docs/source/generated/
+docs/source/sg_execution_times.rst
+# pytorch-sphinx-theme gets installed here
+docs/src
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# System / program generated files
+*.err
+*.log
+*.swp
+.DS_Store
+
+# Translations
+*.mo
+*.pot
+
+# TorchX
+*.torchxconfig
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# VSCode
+.vscode/
+
+# wandb
+wandb/

pylogshield-0.0.1/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Muhammad Hassan
+
+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.

pylogshield-0.0.1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: pylogshield
+Version: 0.0.1
+Summary: A Python logging library designed for data professionals and developers who need reliable, secure logging with minimal setup.
+Author-email: Vertex AI Automations <info@vertexaiautomations.com>
+License-Expression: MIT
+Project-URL: homepage, https://www.vertexaiautomations.com
+Project-URL: documentation, https://vertex-ai-automations.github.io/pylogshield
+Project-URL: repository, https://github.com/vertex-ai-automations/pylogshield
+Project-URL: issues, https://github.com/vertex-ai-automations/pylogshield/issues/new
+Keywords: logger,automation,package,custom,security
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Logging
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.12.0
+
+<a name="readme-top"></a>
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+<img src="https://github.com/vertex-ai-automations/pylogshield/raw/main/docs/img/pylogshield.png" alt="PyLogShield Logo" width="150">
+<p>
+<br>
+<strong>📃
+<a href="https://vertex-ai-automations.github.io/pylogshield"><strong>Examples and Docs</strong></a>
+|🔧
+<a href="https://github.com/vertex-ai-automations/pylogshield/issues/new">Report Bug/Issues</a>
+|⛪
+<a href="https://www.vertexaiautomations.com">Vertex AI Automations</a>|
+</p>
+<br>
+<img src="docs/img/pylogshield_animate.gif" alt="PyLogShield Animation">
+<br>
+</div>
+
+<br>
+
+<details open="true">
+  <summary><strong> :page_with_curl: Table of Contents</string></summary>
+  <ol>
+    <li>
+      <a href="#mega-about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#bulb-features">Features</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#pushpin-getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#family-contributor">Contributors</a></li>
+    <li><a href="#clap-acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+## :mega: About The Project
+A Python logging library designed for data professionals and developers who need reliable, secure logging with minimal setup. It extends Python's standard `logging` module with production-ready features commonly needed in data engineering and application development. It includes features like sensitive data masking, log rotation, asynchronous logging, rate limiting, and dynamic configuration, all while remaining lightweight and easy to use.
+
+<!-- Features -->
+## :bulb: Features
+
+- **Sensitive Data Masking**: Automatically masks predefined sensitive fields (e.g., `password`, `token`) in logs.
+- **Log Filtering**: Filter logs based on specific keywords.
+- **Dynamic Masking Control**: Enable or disable masking on a per-log basis using the `mask` parameter.
+- **Performance Metrics**: Track logs per second for insights into logging activity.
+- **Interactive Log Viewer**: View logs in a structured, styled table using the `rich` library.
+- **Rate Limiting**: Avoid repetitive logs of the same message within a specified interval.
+- **Log Rotation**: Supports rotating log files based on file size, with configurable backup counts.
+- **Asynchronous Logging**: Offload logging to a background thread for improved performance.
+- **JSON Log Formatting**: Optional structured JSON logging for integration with log aggregation tools.
+- **Dynamic Log Level Adjustments**: Update logger settings (e.g., log level) dynamically at runtime.
+- **Reusable Global Logger**: Easily access a shared logger across multiple modules with `get_logger`.
+- **Color-Coded Logs**: Enable `rich` integration for visually enhanced terminal output.
+- **CLI Log Viewer (Static/Live)**: Log viewer using CLI, also supports live viewer and detects for changes.
+- **Custom Log Level**: Runtime custom log level injection (e.g. `SECURITY`, `AUDIT`)
+
+<!-- GETTING STARTED -->
+## :pushpin: Getting Started
+
+### Installation
+
+Install:
+```bash
+pip install pylogshield
+```
+Upgrade:
+```bash
+pip install --upgrade pylogshield
+```
+
+**Documentation**
+
+Full developer docs with API reference, usage, and model schema:
+
+- 👉 [Docs and Examples (PyLogShield)](https://vertex-ai-automations.github.io/pylogshield)
+
+<!--Contributors-->
+
+
+## :family: Contributors
+All contributions are welcome. If you have a suggestion that would make this better, please fork the repo and create a merge request. You can also simply open an issue with the label 'enhancement'.
+
+Don't forget to give the project a star! Thanks again!
+
+ :large_orange_diamond: [View all contributors](CONTRIBUTING.md)
+ 
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>

pylogshield-0.0.1/README.md

@@ -0,0 +1,94 @@
+<a name="readme-top"></a>
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+<img src="https://github.com/vertex-ai-automations/pylogshield/raw/main/docs/img/pylogshield.png" alt="PyLogShield Logo" width="150">
+<p>
+<br>
+<strong>📃
+<a href="https://vertex-ai-automations.github.io/pylogshield"><strong>Examples and Docs</strong></a>
+|🔧
+<a href="https://github.com/vertex-ai-automations/pylogshield/issues/new">Report Bug/Issues</a>
+|⛪
+<a href="https://www.vertexaiautomations.com">Vertex AI Automations</a>|
+</p>
+<br>
+<img src="docs/img/pylogshield_animate.gif" alt="PyLogShield Animation">
+<br>
+</div>
+
+<br>
+
+<details open="true">
+  <summary><strong> :page_with_curl: Table of Contents</string></summary>
+  <ol>
+    <li>
+      <a href="#mega-about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#bulb-features">Features</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#pushpin-getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#family-contributor">Contributors</a></li>
+    <li><a href="#clap-acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+## :mega: About The Project
+A Python logging library designed for data professionals and developers who need reliable, secure logging with minimal setup. It extends Python's standard `logging` module with production-ready features commonly needed in data engineering and application development. It includes features like sensitive data masking, log rotation, asynchronous logging, rate limiting, and dynamic configuration, all while remaining lightweight and easy to use.
+
+<!-- Features -->
+## :bulb: Features
+
+- **Sensitive Data Masking**: Automatically masks predefined sensitive fields (e.g., `password`, `token`) in logs.
+- **Log Filtering**: Filter logs based on specific keywords.
+- **Dynamic Masking Control**: Enable or disable masking on a per-log basis using the `mask` parameter.
+- **Performance Metrics**: Track logs per second for insights into logging activity.
+- **Interactive Log Viewer**: View logs in a structured, styled table using the `rich` library.
+- **Rate Limiting**: Avoid repetitive logs of the same message within a specified interval.
+- **Log Rotation**: Supports rotating log files based on file size, with configurable backup counts.
+- **Asynchronous Logging**: Offload logging to a background thread for improved performance.
+- **JSON Log Formatting**: Optional structured JSON logging for integration with log aggregation tools.
+- **Dynamic Log Level Adjustments**: Update logger settings (e.g., log level) dynamically at runtime.
+- **Reusable Global Logger**: Easily access a shared logger across multiple modules with `get_logger`.
+- **Color-Coded Logs**: Enable `rich` integration for visually enhanced terminal output.
+- **CLI Log Viewer (Static/Live)**: Log viewer using CLI, also supports live viewer and detects for changes.
+- **Custom Log Level**: Runtime custom log level injection (e.g. `SECURITY`, `AUDIT`)
+
+<!-- GETTING STARTED -->
+## :pushpin: Getting Started
+
+### Installation
+
+Install:
+```bash
+pip install pylogshield
+```
+Upgrade:
+```bash
+pip install --upgrade pylogshield
+```
+
+**Documentation**
+
+Full developer docs with API reference, usage, and model schema:
+
+- 👉 [Docs and Examples (PyLogShield)](https://vertex-ai-automations.github.io/pylogshield)
+
+<!--Contributors-->
+
+
+## :family: Contributors
+All contributions are welcome. If you have a suggestion that would make this better, please fork the repo and create a merge request. You can also simply open an issue with the label 'enhancement'.
+
+Don't forget to give the project a star! Thanks again!
+
+ :large_orange_diamond: [View all contributors](CONTRIBUTING.md)
+ 
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>