kami-logging 0.2.1

Kami Logging

Simple decorator to logging and benchmark functions

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments

🧐 About

This package arose from the need to simplify the logging tasks of applications created by the Kami CO software development team.

Currently the package has 4 decorators: benchmark_with, logging_with, default_logging and default_benchmark for logging and basic performance testing with or without a defined logger object;

🏁 Getting Started

These instructions will get you a copy of the package and a daily use example.

Prerequisites

• Python 3.x
• logging library

Installing

$pip install kami-logging

🎈 Usage

The four decorators available are:

• @logging_with: generates a log message of type info at the beginning and end of the function execution, using a logger object defined by the developer

• @default_logging: generates a log message of type info at the beginning and end of function execution, using a default logger object named 'default'

• @benchmark_with: Generates a log message of type info with the runtime of the function accurate to 3 decimal places, using a developer-defined logger object

• @default_benchmark: generates a log message of type info with the runtime of the function accurate to 3 decimal places, using a default logger object named 'default'

import logging
from kami_logging import logging_with, benchmark_with

my_app_logger = logging.getLogger("my_app")

@benchmark_with(my_app_logger)
@logging_with(my_app_logger)
def my_func(*args, **kwargs):
  pass

Result:

⛏️ Built Using

• Python - Database
• Logging - Server Framework

✍️ Authors

• @maicondmenezes - Idea & Initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• References:
  • Arjancodes: Github, Youtube, Twitter
  • Eduardo Mendes: Github, Youtube, Twitter