Skip to main content

A modern, high-performance async logging utility with multiple output formats and colorful console output

Project description

Tamga PyPI Downloads

A modern, high-performance logging utility for Python with multiple output formats and colorful console output.

Installation

🤖 AI Integration: For AI/LLM integration, see LLMs.txt or access documentation directly via Context7

tam·ga /ˈtæmɡə/ · noun An ancient Turkic symbol or seal used for marking ownership, identity, or lineage.

Terminal

✨ Features

  • 🎨 Beautiful Console Output - Colorful, formatted logs using Tailwind CSS colors
  • High Performance - Buffered writing system (10x faster than traditional logging)
  • 📊 Multiple Outputs - Console, file, JSON, SQLite, MongoDB
  • 🔄 Automatic Rotation - File size management with backup support
  • 🧵 Thread-Safe - Safe for multi-threaded applications
  • 🔔 Notifications - Multi-service notifications via Apprise (Discord, Slack, Email, SMS, and more)
  • 🔍 Structured Logging - Key-value data support with all log methods

🚀 Quick Start

See examples/simple_usage.py for a full script.

from tamga import Tamga

# Create logger with default settings
logger = Tamga()

# Log messages
logger.info("Application started")
logger.warning("Memory usage at 85%")
logger.error("Failed to connect to API")
logger.success("User registered successfully")
logger.debug("Cache initialized with 1000 entries")

🧑‍💻 Examples

See examples/ for ready-to-run scripts:

  • simple_usage.py — basic logging
  • fastapi_webapp.py — FastAPI integration
  • advanced_config.py — production config
  • high_performance.py — high-speed big data logging demo

📦 Installation

pip install tamga                    # Basic installation
pip install tamga[mongo]             # With MongoDB support
pip install tamga[notifications]     # With notification support
pip install tamga[all]              # All features

🎯 Usage Examples

Basic Configuration

logger = Tamga(
    # Display settings
    colored_output=True,        # Colored output
    show_time=True,         # Include timestamp
    show_timezone=False,    # Include timezone

    # Output destinations
    file_output=True,        # Log to file
    file_path="app.log",     # Log file path
    buffer_size=50,         # Buffer size for performance
)

Structured Logging

# Log with key-value data using any log method
logger.info("User action",
    user_id="123",
    action="login",
    ip_address="192.168.1.1",
    success=True
)

# Works with all log levels
logger.error("Database connection failed",
    host="localhost",
    port=5432,
    timeout=30,
    retry_count=3
)

logger.success("Payment processed",
    amount=99.99,
    currency="USD",
    method="credit_card",
    transaction_id="tx_123"
)

Production Setup

logger = Tamga(
    # File rotation
    file_output=True,
    max_file_size_mb=50,         # 50MB max file size
    enable_backup=True,     # Create backups

    # Performance
    buffer_size=200,        # Larger buffer for production
    console_output=False,    # Disable console for speed

    # External services
    mongo_output=True,
    mongo_uri="mongodb://...",

    # Multi-service notifications
    notify_services=[
        "discord://webhook_id/webhook_token",
        "slack://tokenA/tokenB/tokenC/#alerts",
        "mailto://user:pass@smtp.gmail.com:587/?to=alerts@company.com",
        "twilio://SID:Token@+1234567890/+0987654321",
    ],
    notify_levels=["CRITICAL", "ERROR", "NOTIFY"],
)

📋 Log Levels

Level Color Method Use Case
INFO Sky logger.info() General information
WARNING Amber logger.warning() Warning messages
ERROR Rose logger.error() Error messages
SUCCESS Emerald logger.success() Success messages
DEBUG Indigo logger.debug() Debug information
CRITICAL Red logger.critical() Critical issues
DATABASE Green logger.database() Database operations
NOTIFY Purple logger.notify() Send notifications
METRIC Cyan logger.metric() Performance metrics
TRACE Gray logger.trace() Detailed trace info
CUSTOM Any logger.custom() Custom levels

🔧 Advanced Features

Notifications

# Configure notification services (supports 80+ services via Apprise)
logger = Tamga(
    notify_services=[
        "discord://webhook_id/webhook_token",
        "slack://tokenA/tokenB/tokenC/#channel",
    ],
    notify_levels=["CRITICAL", "ERROR", "NOTIFY"],
    notify_title="{appname}: {level} Alert",
    notify_format="markdown",  # text, markdown, or html
)

# Send notification
logger.notify("Payment received from user #123")

# Critical logs also trigger notifications
logger.critical("Database connection lost")

Custom Log Levels

logger.custom("Deploy completed", "DEPLOY", "purple")
logger.custom("Payment received", "PAYMENT", "green")

Buffer Control

# Force write all buffered logs
logger.flush()

File Rotation

When log files reach max_file_size_mb, Tamga automatically:

  • Creates timestamped backups (if enabled)
  • Clears the original file
  • Continues logging seamlessly

📊 Performance

Tamga uses a buffered writing system that delivers significantly faster performance compared to traditional logging. The buffering mechanism provides optimal throughput for high-volume logging scenarios while maintaining thread safety.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Links


Made with ❤️ by Doğukan Ürker

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

tamga-1.4.0.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

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

tamga-1.4.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file tamga-1.4.0.tar.gz.

File metadata

  • Download URL: tamga-1.4.0.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.20

File hashes

Hashes for tamga-1.4.0.tar.gz
Algorithm Hash digest
SHA256 960faf5cc6a19333aeb04d45ec0980d3f6ad5bcbbd5075d7925e644552011c02
MD5 5a8878dfbb04e52dc7c5ea3e70e359d4
BLAKE2b-256 eb2b1f8841bb4d36b950bb283bd833ccddc8a646858806a3f4ca0b9ba23b6ed9

See more details on using hashes here.

File details

Details for the file tamga-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: tamga-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.20

File hashes

Hashes for tamga-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2000fb9410582278337af15b397efe76ba96c72d57b81c9af5b626085bbe092
MD5 7a70eebfbcc28e8bca92b2a53b24f24a
BLAKE2b-256 bf1aa7dbf8d4f381db5bd941c3db4bcb4932a3b1dcfdb1b9e926a5bde402ce02

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