Metadata-Version: 2.1
Name: logging-extras
Version: 0.3.0b0
Summary: Python logging extensions
Home-page: https://github.com/zobayer1/logging-extras
Author: Zobayer Hasan
Author-email: zobayer1@gmail.com
License: MIT
Description: 
        LOGGING EXTRAS
        ===============
        
        A collection of various python logging extensions.
        
        [![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blueviolet?logo=python&logoColor=green)](https://www.python.org)
        [![PyPi Publish](https://github.com/zobayer1/logging-extras/actions/workflows/python-publish.yml/badge.svg)](https://github.com/zobayer1/logging-extras/actions/workflows/python-publish.yml)
        [![Python Builds](https://github.com/zobayer1/logging-extras/actions/workflows/python-package.yml/badge.svg)](https://github.com/zobayer1/logging-extras/actions/workflows/python-package.yml)
        [![codecov](https://codecov.io/gh/zobayer1/logging-extras/branch/main/graph/badge.svg?token=GKB7RKRQ81)](https://codecov.io/gh/zobayer1/logging-extras)
        [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-blue?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![Documentation Status](https://readthedocs.org/projects/logging-extras/badge/?version=latest)](https://logging-extras.readthedocs.io/en/latest/?badge=latest)
        [![License: MIT](https://img.shields.io/badge/License-MIT-ff69b4.svg)](https://github.com/zobayer1/logging-extras/blob/main/LICENSE)
        
        Documentation
        -------------
        [https://logging-extras.readthedocs.io/en/latest/](https://logging-extras.readthedocs.io/en/latest/)
        
        Installation
        ------------
        
        Install [logging-extras](https://pypi.org/project/logging-extras/) using pip
        
            pip install logging-extras
        
        Alternatively, download the latest binary or source package from [github](https://github.com/zobayer1/logging-extras/releases)
        
        Install wheel package with `pip`:
        
            pip install logging_extras-{tags}.whl
        
        Install source package as editable:
        
            tar -xf logging-extras-{tags}.tar.gz
            cd logging-extras-{tags}
            pip install -e .
        
        Please refer to documentation pages for available modules.
        
        Module Index
        ============
        
        config.YAMLConfig
        -----------------
        
        YAMLConfig class can be used for loading YAML files with custom tags. This class adds a custom envvar tag to native YAML parser which is used to evaluate environment variables. Supports one or more environment variables in the form of `${VARNAME}` or `${VARNAME:DEFAULT}` within a string. If no default value is specified, empty string is used. Default values can only be treated as plain strings. YAMLConfig can also expand `~` or `~username` just like shells do, either directly hardcoded in YAML file or passed through environment variables.
        
        ### Example configuration:
        
        File: **logging.yaml**
        ```
        version: 1
        formatters:
          simple:
            format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
        handlers:
          console:
            class: logging.StreamHandler
            formatter: simple
            stream: ext://sys.stdout
          file_handler:
            class: logging.FileHandler
            filename: ${LOGGING_ROOT:.}/${LOG_FILENAME}
            formatter: simple
        loggers:
          test_logger:
            level: DEBUG
            handlers:
              - file_handler
            propagate: no
        root:
          level: NOTSET
          handlers:
            - console
        ```
        
        **Note:** Ignore the backslashes as markdown must display those escape characters.
        
        ### Example Usage
        
        File: **test_logger.py**
        ```
        import logging
        from logging_.config import YAMLConfig
        
        with open("logging.yaml", "r") as config_file:
            YAMLConfig(config_file.read(), silent=True)
        
        # alternatively, you can use
        # YAMLConfig.from_file("logging.yaml", silent=True)
        
        logger = logging.getLogger("test_logger")
        
        logger.debug("This is a debug log")
        logger.info("This is an info log")
        logger.warning("This is an warning log")
        logger.error("This is an error log")
        logger.critical("This is a critical log")
        ```
        
        **Note:** An (optional) explicit `silent=True` flag must be set to suppress any file or parsing related exceptions to be thrown.
        
        handlers.QueueListenerHandler
        -----------------------------
        
        A simple `QueueHandler` subclass implementation utilizing `QueueListener` for configured handlers. This is helpful for detaching the logger handlers from the main threads, which reduces the risk of getting blocked, for example, when using slower handlers such as smtp, file, or socket handlers.
        
        ### Example configuration:
        
        File: **logging.yaml**
        ```
        version: 1
        objects:
          queue:
            class: queue.Queue
            maxsize: 1000
        formatters:
          simple:
            format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
        handlers:
          console:
            class: logging.StreamHandler
            formatter: simple
            stream: ext://sys.stdout
          file_handler:
            class: logging.FileHandler
            filename: test_logger.log
            formatter: simple
          queue_handler:
            class: logging_.handlers.QueueListenerHandler
            handlers:
              - cfg://handlers.console
              - cfg://handlers.file_handler
            queue: cfg://objects.queue
        loggers:
          test_logger:
            level: DEBUG
            handlers:
              - queue_handler
            propagate: no
        root:
          level: NOTSET
          handlers:
            - console
        ```
        
        **Note:** A queue object must be passed since the handler does not set a default queue implementation. Set `maxsize: -1` to make the queue unlimited.
        
        ### Example Usage
        
        File: **test_logger.py**
        ```
        import logging.config
        import yaml
        
        with open("logging.yaml", "r") as config_file:
            logging_config = yaml.safe_load(config_file.read())
            logging.config.dictConfig(logging_config)
        
        logger = logging.getLogger("test_logger")
        
        logger.debug("This is a debug log")
        logger.info("This is an info log")
        logger.warning("This is an warning log")
        logger.error("This is an error log")
        logger.critical("This is a critical log")
        ```
        
        Development
        ===========
        
        Additional development and documentation dependencies can be installed using extras. It is recommended to use a virtualenv.
        
        ### Use Pre-Commit Hooks
        
        Install pre-commit hooks and dependencies:
        
            pip install pre-commit
            pre-commit install
            pre-commit autoupdate
            pre-commit run --all-files
        
        ### Run Tests
        
        Run tests from the source with Pytest:
        
            pip install -e .[dev]
            pytest -s
        
        ### Generate Documentation
        
        Generate documentation from the source with Sphinx:
        
            pip install -e .[doc]
            cd docs
            mkdir -p _static _templates
            make html
            python -m http.server --directory build/html
        
        ### No `requirements.txt` File
        
        This is a python library package that is compatible with a wide range of Python versions. It does not make much sense to pin dependency versions in a traditional `requirements.txt` file. Instead, this project utilizes modern python packaging paradigms with `pyproject.toml` and `setup.cfg` files. However, sometimes some IDEs (i.e. PyCharm) cannot resolve dependencies without a `requirements.txt` file. To generate a `requirements.txt` file, simply run the following command within your venv:
        
            pip freeze > requirements.txt
        
        ### Create Distribution Packages
        
        To create a source and wheel distribution, run:
        
            git clone git@github.com:zobayer1/logging-extras.git
            python -m pip install wheel
            python setup.py clean sdist bdist_wheel
        
        **Note:** This project uses `setuptools-scm` to generate build versions from git tags. Build system will raise errors if you are trying to build packages outside a git repo.
        
Keywords: python logging logger handler custom config dictconfig yaml
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: doc
