Metadata-Version: 2.1
Name: hclogger
Version: 1.0.2
Summary: A hierarchical and colourful logging module
Home-page: https://github.com/gaborod16/HCLogger
Author: Gabriel Amarista
Author-email: gaborod16@gmail.com
License: UNKNOWN
Description: ## Hierarchical Colored Logger Module for Python
        
        HCLogger is a logging module using [Termcolor](https://pypi.org/project/termcolor/) and a hierarchical format to improve readability.
        
        Note: this module was designed to deal with concurrency. However, it is encouraged to store thread logs into different log files.
        
        ![HCLogger capture](hclogger/tests/function_test.png)
        
        ### Installation
        
        Not yet in PyPi.
        
        ### Usage
        
        As simple as it could be:
        
        ```python
        from HCLogger import Logger
        
        logger = Logger(filename='fname.log', verbose=False)
        logger.debug('This is a debug message.')
        ```
        
        Output:
        
        ![Debug output](hclogger/tests/debug_message.png)
        
        The hierarchy is added to functions. In order to add hierarchy on of the following alternatives must be used:
        
        ```python
        # The manual call
        logger.manual_log_func(func, args*)
        
        # The decorated call
        @logger.log_func
        def func(args):
        	...
        
        func()
        ```
        
        Output:
        
        ![Function logging](hclogger/tests/function_log.png)
        
        Putting it all together:
        
        ![Demo capture](hclogger/tests/demo_capture.png)
        
        ## Future work
        
         - [ ] Add to PyPi
         - [ ] Create web view
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Logging
Description-Content-Type: text/markdown
