Metadata-Version: 2.1
Name: gytrash
Version: 0.0.16
Summary: Useful things for Logging.
Home-page: http://github.com/trejas/gytrash
Author: Traey Hatch
Author-email: thatch@newmathdata.com
License: Apache 2.0
Project-URL: Source, https://github.com/trejas/gytrash
Description: # Gytrash
        A logging setup module for Python. When setting up logging functionality for new projects I noticed I was always following the same pattern. 
        
        Decided to put these practices into a module. The module sets up a logger using `coloredlogs`. You can attach the botocore logs, if you are a regular user of boto3. And the logger can easily ship logging messages to slack.
        ## Installation
        `pip install gytrash`
        
        ## Examples
        ### Simple logging setup
        ```
        import gytrash
        import logging
        log = logging.getLogger("slack_example")
        
        gytrash.setup_logging(log, log_level=10)
        
        log.info("Test info message")
        log.debug("Test debug message")
        ```
        
        ### Setup logger for use with Slack
        To use gytrash to ship logging messages to slack, first setup a slack app using this [walkthrough](https://github.com/slackapi/python-slack-sdk/blob/main/tutorial/01-creating-the-slack-app.md)
        
        Once you have generated the bot token, save it as an environment variable.
        ### Set Slack Environment Variables
        `export SLACK_BOT_TOKEN="<BOT TOKEN>"`
        
        Finally setup gytrash using the extended parameters.
        ### Import Gytrash and setup logger to use Slack
        ```
        import gytrash
        import logging
        log = logging.getLogger("slack_example")
        
        gytrash.setup_logging(log, log_level=10, log_from_botocore=False, log_to_slack=True, slack_log_channel="<LOG NAME>", slack_log_level=20)
        
        log.info("Test info message")
        log.debug("Test debug message")
        
        log.info("Test info message", extra={"notify_slack": True})  # send this log message to slack
        ```
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
