Skip to main content

A Python logging library designed for data professionals and developers who need reliable, secure logging with minimal setup.

Project description


📋 Table of Contents

📣 Overview

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

  • 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)

📌 Quick Start

Installation

Install:

pip install pylogshield

Upgrade:

pip install --upgrade pylogshield

Documentation

Full developer docs with API reference, usage, and model schema:

👪 Contributing

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!

🔶 View all contributors

(back to top)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pylogshield-0.0.2.tar.gz (511.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pylogshield-0.0.2-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file pylogshield-0.0.2.tar.gz.

File metadata

  • Download URL: pylogshield-0.0.2.tar.gz
  • Upload date:
  • Size: 511.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for pylogshield-0.0.2.tar.gz
Algorithm Hash digest
SHA256 b42c7283ecee35f4270ab6ba42c37acee53f480165c9c69efacdbf96ea6809ed
MD5 f7bdba002571671321b656488a5a2206
BLAKE2b-256 d078f87e15b96c0efd9470b7faada364f55ba9f26200def40e7f3572e41d45b3

See more details on using hashes here.

File details

Details for the file pylogshield-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: pylogshield-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for pylogshield-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2ee3298bb80036ddf5027d97993be5748b71a06cb856cf60fb0c714fa17db3cf
MD5 720c21dbf139bc9ea3ac2532f1ab0aa0
BLAKE2b-256 64976fae2dd91dc120db76732cac8f14aae5d4a009cf95d3c704369eb2ef145e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page