Metadata-Version: 2.1
Name: algomax-common
Version: 0.1
Summary: a common package for algomax-cli and algomax-engine
Home-page: https://mabnadp.com
Author: mabna DP
Author-email: mabnadp@gmail.com
License: UNKNOWN
Description: # Algomax-Common
        
        A common tools for working with **algomax-cli** and **algomax-engine**.
        
        install the package with bellow command:
        
        `-> pip install algomax-common`
        
        ##Logging
        
        Adding logging to your Python program is as easy as this:
        
        `from algomax_common.logger import AMLogger`
        
        ###Initiate the logger
        add below code on top of your programs file
        
        `AMLogger.init()`
        
        and, use it:
        
        `AMLogger.info('order created successfully', extra=with_this_data)`
        
        `AMLogger.error('order creation failed', extra=order_data_and_error)`
        
        **Note**: extra is a dict
        
        ###Explore log files
        above code creates a directory named `logs` in your project directory.
        
        log directory structure:
        
            logs
            |____ error.json    # contains AMLogger.error() records
            |____ info.json     # contains AMLogger.info() records
        
        
        
Keywords: algomax-common
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
