Skip to main content

🔍 Tracemate: A comprehensive tracing and logging toolkit for Python CLI applications.

Project description

Tracemate :mag_right:

Python License Build PyPI Downloads

Automated logging setup for Python applications

Tracemate is a Python library designed to make logging hassle-free. Just import it into your main.py, and Tracemate takes care of setting up logging for all your functions. It's lightweight, easy to integrate, and designed to have minimal impact on application performance.

Tracemate Logo


:rocket: Features

  • Automated Logging: Just import Tracemate in your main.py and it will automatically set up logging for all your functions.
  • High Performance: Designed for minimal performance overhead.
  • Asynchronous Support: Full support for asynchronous Python applications.
  • Simple Integration: Easy to integrate into existing projects without modifying your codebase.

:package: Installation

To install Tracemate, you can use pip:

pip install tracemate

:hammer_and_wrench: Usage

Here's how to get started:

Use this in your main.py (or equivalent) file to autonomously add logging and obtain logger and console objects from a centralized location. You can use setup_logging from multiple modules and it works fine.

from tracemate import setup_logging, apply_logger_to_all_functions

backend_logger, ui_logger, console = setup_logging()
apply_logger_to_all_functions(backend_logger)

For a more comprehensive guide, please refer to the Documentation.


📖 Documentation

Detailed documentation is available on our Wiki.


:handshake: Contributing

Contributions, issues, and feature requests are welcome! See CONTRIBUTING.md for how to get started.


:memo: License

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


:telephone_receiver: Contact

Created by @alexfigueroa-solutions - feel free to reach out!

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

tracemate-0.1.1.tar.gz (6.6 kB view hashes)

Uploaded Source

Built Distribution

tracemate-0.1.1-py3-none-any.whl (7.5 kB view hashes)

Uploaded Python 3

Supported by

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