Metadata-Version: 2.1
Name: aelog
Version: 1.0.3
Summary: An simple, async, full package name path, log rotating, different colored log library.
Home-page: https://github.com/tinybees/aelog
Author: TinyBees
Author-email: a598824322@qq.com
License: MIT
Description: # Aelog
        An simple, async, full package name path, log rotating, different colored log library.
        
        aelog aims to make using python log as simple as possible. as a result, it drastically 
        simplifies using python logging.
        
        aelog's design objectives:
        
        - Make using python log as simple as possible.
        - Output log contains the full package name path.
        - Provide asynchronous log output function, at the same time, contains common log output.
        - Output according to the log level to mark the different colors separately.
        - Provide a log file rotating, automatic backup.
        - Output to the terminal and file, default output to the terminal, if you don't provide the log file path.
        
        # Installing aelog
        - ```pip install aelog```
        
        # init aelog 
        ```
        import aelog 
        
        app = Flask(__name__)
        
        aelog.init_app(app)
        # or 
        aelog.init_app(aelog_access_file='aelog_access_file.log', aelog_error_file='aelog_error_file.log', 
                       aelog_console=False)
        ```
        # aelog config
        List of configuration keys that the aelog extension recognizes:
        
        
        | configuration key | the meaning of the configuration key |
        | ------ | ------ |
        | AELOG_ACCESS_FILE | Access file path, default None. |
        | AELOG_ERROR_FILE | Error file path, default None. |
        | AELOG_CONSOLE | Whether it is output at the terminal, default false. |
        | AELOG_MAX_BYTES | Log file size, default 50M. |
        | AELOG_BACKUP_COUNT | Rotating file count, default 5.|
        
        # Usage
        ### simple using, not initialized.
        ```
        import aelog
        
        def test_aelog_output_console():
            """
        
            Args:
        
            Returns:
        
            """
            aelog.debug("simple debug message")
            aelog.info("simple info message")
            aelog.warning("simple warning message")
            aelog.error("simple error message")
            aelog.critical("simple critical message")
            try:
                5 / 0
            except Exception as e:
                aelog.exception(e)
        ```
        This will output to the terminal.  
        ![console](https://raw.githubusercontent.com/tinybees/aelog/master/docs/output_console.png)
        - Different levels of logging, different color, the color is cyan, green, yellow, red and 'bold_red,bg_white' in turn.
        
        ### To initialize, output log to file and terminal.
        ```
        import aelog
        from flask import Flask
        
        app = Flask(__name__)
        
        aelog.init_app(app)  # Output to the test.log file and terminal 
        
        def test_aelog_output_file():
            """
        
            Args:
        
            Returns:
        
            """
            aelog.debug("simple debug message")
            aelog.info("simple info message")
            aelog.warning("simple warning message")
            aelog.error("simple error message")
            aelog.critical("simple critical message")
            try:
                5 / 0
            except Exception as e:
                aelog.exception(e)
        ```
        This will output to the test.log file and terminal.
        ![console](https://raw.githubusercontent.com/tinybees/aelog/master/docs/output_file.png)
        - Automatic output is greater than the error information to the 'test_error.log' file.
        - Different levels of logging, different color, the color is cyan, green, yellow, red and 'bold_red,bg_white' in turn.
        
        ### To initialize, asynchronous output log to file and terminal.
        ```
        import asyncio
        import aelog
        from sanic import Sanic
        
        app = Sanic(__name__)
        
        aelog.init_aelog(app)  # Output to the test.log file and terminal 
        
        async def test_async_output():
            await aelog.async_debug("simple debug message")
            await aelog.async_info("simple info message")
            await aelog.async_warning("simple warning message")
            await aelog.async_error("simple error message")
            await aelog.async_critical("simple critical message")
            try:
                5 / 0
            except Exception as e:
                await aelog.async_exception(e)
        
        if "__name__"=="__main__":
            loop = asyncio.get_event_loop()
            loop.run_until_complete(test_async_output())
        ```
        This will output to the test.log file and terminal.
        ![console](https://raw.githubusercontent.com/tinybees/aelog/master/docs/async_output.png)
        - Automatic output is greater than the error information to the 'test_error.log' file.  
        - Different levels of logging, different color, the color is cyan, green, yellow, red and 'bold_red,bg_white' in turn.
        
Keywords: log,logging,colored,async,asynchronous,simple,rotating
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: Chinese (Simplified)
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires: colorlog
Requires-Python: >=3.5
Description-Content-Type: text/markdown
