Metadata-Version: 2.1
Name: lib-log-utils
Version: 0.0.1
Summary: lib_log_utils
Home-page: https://github.com/bitranox/lib_log_utils
Author: Robert Nowotny
Author-email: rnowotny1966@gmail.com
License: UNKNOWN
Description: lib_log_utils
        =============
        
        |Pypi Status| |license| |maintenance|
        
        |Build Status| |Codecov Status| |Better Code| |code climate| |snyk security|
        
        .. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg
           :target: http://en.wikipedia.org/wiki/MIT_License
        .. |maintenance| image:: https://img.shields.io/maintenance/yes/2019.svg
        .. |Build Status| image:: https://travis-ci.org/bitranox/lib_log_utils.svg?branch=master
           :target: https://travis-ci.org/bitranox/lib_log_utils
        .. for the pypi status link note the dashes, not the underscore !
        .. |Pypi Status| image:: https://badge.fury.io/py/lib-log-utils.svg
           :target: https://badge.fury.io/py/lib_log_utils
        .. |Codecov Status| image:: https://codecov.io/gh/bitranox/lib_log_utils/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/bitranox/lib_log_utils
        .. |Better Code| image:: https://bettercodehub.com/edge/badge/bitranox/lib_log_utils?branch=master
           :target: https://bettercodehub.com/results/bitranox/lib_log_utils
        .. |snyk security| image:: https://snyk.io/test/github/bitranox/lib_log_utils/badge.svg
           :target: https://snyk.io/test/github/bitranox/lib_log_utils
        .. |code climate| image:: https://api.codeclimate.com/v1/badges/fa8ed1c6aec724d3b4f7/maintainability
           :target: https://codeclimate.com/github/bitranox/lib_log_utils/maintainability
           :alt: Maintainability
        
        some convenience functions for logging
        
        supports python 3.7 and possibly other dialects.
        
        `100% code coverage <https://codecov.io/gh/bitranox/lib_log_utils>`_, mypy static type checking, tested under `Linux, OsX, Windows and Wine <https://travis-ci.org/bitranox/lib_log_utils>`_, automatic daily builds  and monitoring
        
        ----
        
        - `Installation and Upgrade`_
        - `Basic Usage`_
        - `Requirements`_
        - `Acknowledgements`_
        - `Contribute`_
        - `Report Issues <https://github.com/bitranox/lib_log_utils/blob/master/ISSUE_TEMPLATE.md>`_
        - `Pull Request <https://github.com/bitranox/lib_log_utils/blob/master/PULL_REQUEST_TEMPLATE.md>`_
        - `Code of Conduct <https://github.com/bitranox/lib_log_utils/blob/master/CODE_OF_CONDUCT.md>`_
        - `License`_
        - `Changelog`_
        
        ----
        
        Installation and Upgrade
        ------------------------
        
        From source code:
        
        .. code-block:: bash
        
            # normal install
            python setup.py install
            # test without installing
            python setup.py test
        
        via pip latest Release:
        
        .. code-block:: bash
        
            # latest Release from pypi
            pip install lib_log_utils
        
            # test without installing
            pip install lib_log_utils --install-option test
        
        via pip latest Development Version:
        
        .. code-block:: bash
        
            # upgrade all dependencies regardless of version number (PREFERRED)
            pip install --upgrade git+https://github.com/bitranox/lib_log_utils.git --upgrade-strategy eager
            # normal install
            pip install --upgrade git+https://github.com/bitranox/lib_log_utils.git
            # test without installing
            pip install git+https://github.com/bitranox/lib_log_utils.git --install-option test
        
        via requirements.txt:
        
        .. code-block:: bash
        
            # Insert following line in Your requirements.txt:
            # for the latest Release:
            lib_log_utils
            # for the latest Development Version :
            git+https://github.com/bitranox/lib_log_utils.git
        
            # to install and upgrade all modules mentioned in requirements.txt:
            pip install --upgrade -r /<path>/requirements.txt
        
        via python:
        
        .. code-block:: python
        
            # for the latest Release
            python -m pip install upgrade lib_log_utils
        
            # for the latest Development Version
            python -m pip install upgrade git+https://github.com/bitranox/lib_log_utils.git
        
        Basic Usage
        -----------
        
        TBA
        
        Requirements
        ------------
        following modules will be automatically installed :
        
        .. code-block:: bash
        
            ## Test Requirements
            ## following Requirements will be installed temporarily for
            ## "setup.py install test" or "pip install <package> --install-option test"
            typing ; python_version < "3.5"
            pathlib; python_version < "3.4"
            mypy ; platform_python_implementation != "PyPy" and python_version >= "3.5"
            pytest
            pytest-pep8 ; python_version < "3.5"
            pytest-codestyle ; python_version >= "3.5"
            pytest-mypy ; platform_python_implementation != "PyPy" and python_version >= "3.5"
            pytest-runner
        
            ## Project Requirements
            lib_cast
            lib_parameter
            lib_doctest_pycharm
        
        Acknowledgements
        ----------------
        
        - special thanks to "uncle bob" Robert C. Martin, especially for his books on "clean code" and "clean architecture"
        
        Contribute
        ----------
        
        I would love for you to fork and send me pull request for this project.
        - `please Contribute <https://github.com/bitranox/lib_log_utils/blob/master/CONTRIBUTING.md>`_
        
        License
        -------
        
        This software is licensed under the `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_
        
        ---
        
        Changelog
        =========
        
        0.0.1
        -----
        2019-09-03: Initial public release
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
