Metadata-Version: 1.2
Name: logme
Version: 1.2.1
Summary: package for easy logging
Home-page: https://github.com/BNMetrics/logme
Author: Luna Chen
Author-email: luna@bnmetrics.com
License: Apache 2.0
Description: ================================
        Logme - Python Logging Made Easy
        ================================
        
        .. image:: https://badge.fury.io/py/logme.svg
            :target: https://pypi.org/project/logme/
        
        .. image:: https://travis-ci.org/BNMetrics/logme.svg?branch=master
            :target: https://travis-ci.org/BNMetrics/logme
        
        .. image:: https://codecov.io/gh/BNMetrics/logme/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/BNMetrics/logme
        
        .. image:: https://readthedocs.org/projects/logme/badge/?version=latest
            :target: https://logme.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        Logme is a Python package that makes logging simple and robost. If you have found
        logging in Python not so straight forward, download this package and give it a try! :)
        
        
        v1.2.0 Updates
        --------------
        
        **logme** package now supports color and styling output in the terminal!
        
        The colors and style is **customizable** in ``logme.ini``, here is a screenshot of how it looks like in the terminal:
        
        
        .. image:: http://logme.readthedocs.io/en/latest/_images/demo_color.png
        
        To use color output in logme, make sure your logme package and ``logme.ini`` is `up-to-date <https://logme.readthedocs.io/en/latest/?badge=latest#upgrading>`_.
        
        Check the configuration details `here <https://logme.readthedocs.io/en/latest/guide/quickstart.html#colors>`_.
        
        
        
        In A Nutshell
        -------------
        
        If you have a function you want to log, you can do this in your python file:
        
        .. code-block:: python
        
            import logme
        
        
            @logme.log
            def my_awesome_function(my_arg, logger=None):
                logger.info('this is my log message')
                """rest of the function"""
        
        
        You can do the same with classes too:
        
        .. code-block:: python
        
            import logme
        
        
            @logme.log
            class MyAwesomeClass:
                def my_function(self, my_arg):
                    self.logger.info('this is my log message')
        
        
        
        pretty nice right? :)
        
        To get started, head to the `quickstart <https://logme.readthedocs.io/en/latest/guide/quickstart.html>`_  page.
        
        Documentation
        -------------
        
        You can find the documentation at https://logme.readthedocs.io/en/latest/ .
        Give it a try!
        
        
Keywords: logging,cli
Platform: UNKNOWN
Requires-Python: >=3
