Metadata-Version: 2.1
Name: SmileLog
Version: 1.2.0
Summary: Log library
Home-page: https://github.com/sitthykun/smilelog
Author: Sitthykun LY
Author-email: ly.sitthykun@gmail.com
License: MIT License
Description: # SmileLog
        
        It's gonna change the traditional tracing in another way.\
        What will it assist us.
         
        1. Colorise output
        2. Be able to stop any output via its public id
        3. Split each output with a big span and symbols
        4. Generate a new dynamic log filename
        5. Disable the entire tracking in a second
        6. 5 methods for 5 outputs
        
        ### 5 Methods
        Use in different situation, and show up in different color
        1. track: track(title, content)
        2. information: info(title, content)
        3. success: success(title, content)
        4. warning: warning(title, content)
        5. error: error(title, content)
        ```
        - title is a string
        - content can be a string or dict
        ```
        
        #### Start using in the simple way:
        
        ```
        from smilelog import Logger
        
        
        # first instant
        log = Logger(
                    enable= True
        	)
        
        # try to print out
        log.info(
        	'My Info Title'
        	, {'data':'My Dictionary Content'}
        	)
        
        # success method
        log.success(
        	'My Success Title'
                , 'My String'
                )
        ```
        
        ### Logger
        
        Logger is a tracing class library and write/output into a file.\
        This will need generating a file and keep writing the content.
        Let's Look at its configure would explain more:
        
        ```
        log	= Logger(
                    path: str, 
                    prefix: str, 
                    extension: str, 
                    formatFileName: str, 
                    enableLog: bool= True,
                    enableConsole: bool= True,
                    color: bool = True
        	)
        ```
        - path: is a directory
        ```
        Ex:
        /var/www/my-project/logs/
        ```
        - formatFileName: is suffix name of log file
        ```
        # set filename
        formatFileName = 'my-logger'
        Ex:
        /var/www/my-project/logs/my-logger
        
        # in dynamic way
        formatFileName = '%Y-%m-%d'
        Ex:
        /var/www/my-project/logs/2020-01-19
        ```
        - extension: is an extension of log file. The standard extension is '.log'
        ```
        # set extension
        extension = '.log'
        Ex:
        /var/www/my-project/logs/2020-01-19.log
        ```
        - prefix: is prefix name of a new file log. 
        ```
        # set prefix
        prefix= 'my-log-'
        
        Ex: 
        /var/www/my-project/logs/my-log-2020-01-19.log 
        # some app move it into system log directory, it is an advantage of prefix
        
        Ex:
        /var/log/my-project-2020-01-19.log
        ```
        - color: is for showing the color on terminal with tail command or terminal editor.
        ```
        # set color
        color= True
        or
        color= False
        ```
        - enable: is a main parameter that determines above features. It has two value only.
        	- True: To enable the logging
        	- False: To disable the logging
        ```
        # set enable
        # set enable
        # enable to write log file
        enableLog= True
        # enable to print out
        enableConsole= True
        ```
        
        ### Disable print out
        The most feature developer guy needs.\
        It will disable only the index that we set in the disable list.
        ##### Note: 
        console and log object are not related each other.
        
        ```
        # Logger instant
        # Ex: Logger logged 10 times
        # but we will show some id except 1,2,3,7,8,9
        # do this
        log.disable([1,2,3,7,8,9])
        ```
        
        ### Output
        It's gonna show like this:
        ```
        02:48:29 <id: 6>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
        [SUCCESS] Success 
        {'data': 'my content'} 
        <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
        
        
        
        02:48:29 <id: 8>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
        [WARNING] Warning 
        {'data': 'my content'} 
        <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
        
        
        
        02:48:29 <id: 9>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
        [SUCCESS] Success 
        {'data': 'my content'} 
        <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
        
        
        
        02:48:29 <id: 10>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
        [SUCCESS] Success 
        Hello String 
        <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
        
        ```
        
        ##### My unique slogan is:
        a little developer in the big world \o/
        
Keywords: smilelog,log,logger,console,consoler
Platform: All
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
