Metadata-Version: 2.2
Name: tamga
Version: 0.1.14
Summary: A modern, async-capable logging utility with multiple output formats and colorful console output
Author-email: Doğukan Ürker <dogukanurker@icloud.com>
License: MIT
Project-URL: Homepage, https://tamga.vercel.app/
Project-URL: Documentation, https://tamga.vercel.app/
Project-URL: Source, https://github.com/dogukanurker/tamga/
Keywords: logging,async,mongodb,colorful,console,file,json,sql,email
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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: Topic :: System :: Logging
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: mongo
Requires-Dist: pymongo<4.9; extra == "mongo"
Requires-Dist: motor<3.6; extra == "mongo"
Provides-Extra: api
Requires-Dist: requests>=2.31.0; extra == "api"
Provides-Extra: full
Requires-Dist: pymongo<4.9; extra == "full"
Requires-Dist: motor<3.6; extra == "full"
Requires-Dist: requests>=2.31.0; extra == "full"

# Tamga [![PyPI Downloads](https://static.pepy.tech/badge/tamga)](https://pepy.tech/projects/tamga)

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

[![Installation](https://belg-api.vercel.app/badge/installation/pip3%20install%20tamga/neutral/dark)](https://pypi.org/project/tamga/)

tam·ga / noun  
An ancient Turkic symbol or seal used for marking ownership, identity, or lineage.

<img alt="Terminal" src="https://github.com/DogukanUrker/Tamga/blob/main/Images/terminal.png?raw=true" />

## Features

- 🎨 Colorful console output using Tailwind CSS color palette
- 📁 File logging with rotation and backup
- 📊 JSON logging with size limits and backup
- 🗄️ SQLite database logging
- 🚀 MongoDB integration
- 📧 Email notifications for specific log levels
- 🌐 API logging support
- 🔄 Automatic file rotation and backup
- 🎯 Multiple log levels with customizable colors

## Installation

To install the `tamga` package, you can use the following commands based on your requirements:

- Basic installation:

  ```bash
  pip install tamga
  ```

- With API logging support:

  ```bash
  pip install tamga[api]
  ```

- With MongoDB integration:

  ```bash
  pip install tamga[mongo]
  ```

- Full installation with all features:
  ```bash
  pip install tamga[full]
  ```

## Quick Start

```python
from tamga import Tamga

# Initialize the logger
logger = Tamga(
    logToFile=True,
    logToJSON=True,
    logToConsole=True
)

# Basic logging
logger.info("This is an info message")
logger.warning("This is a warning")
logger.error("This is an error")
logger.success("This is a success message")
logger.debug("This is a debug message")
logger.critical("This is a critical message")

# Custom logging
logger.custom("This is a custom message", "CUSTOM", "orange")
```

## Advanced Usage

### MongoDB Integration

```python
logger = Tamga(
    logToMongo=True,
    mongoURI="your_mongodb_uri",
    mongoDatabaseName="logs_db",
    mongoCollectionName="application_logs"
)
```

### Email Notifications

```python
logger = Tamga(
    sendMail=True,
    smtpServer="smtp.gmail.com",
    smtpPort=587,
    smtpMail="your_email@gmail.com",
    smtpPassword="your_password",
    smtpReceivers=["receiver@email.com"],
    mailLevels=["CRITICAL", "ERROR"]
)
```

### File Rotation and Backup

```python
logger = Tamga(
    logToFile=True,
    logToJSON=True,
    maxLogSize=10,  # MB
    maxJsonSize=10,  # MB
    enableBackup=True
)
```

### API Integration

```python
logger = Tamga(
    logToAPI=True,
    apiURL="http://your-api.com/logs"
)
```

## Available Log Levels

- INFO (sky blue)
- WARNING (amber)
- ERROR (rose)
- SUCCESS (emerald)
- DEBUG (indigo)
- CRITICAL (red)
- DATABASE (green)
- MAIL (neutral)
- METRIC (cyan)
- TRACE (gray)
- Custom (user-defined)

## Contributing

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

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Author

- Doğukan Ürker
- Email: dogukanurker@icloud.com
- GitHub: [@dogukanurker](https://github.com/dogukanurker)
