log-utils-sdk 0.4.1__tar.gz

log_utils_sdk-0.4.1/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

log_utils_sdk-0.4.1/PKG-INFO

@@ -0,0 +1,287 @@
+Metadata-Version: 2.1
+Name: log_utils_sdk
+Version: 0.4.1
+Summary: Utils for generic python logging package
+Home-page: https://github.com/wolf1986/log_utils
+Author: Willy Polychenko
+Author-email: wolf1986@gmail.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.10
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+[![Build Status](https://app.travis-ci.com/wolf1986/log_utils.svg?branch=master)](https://app.travis-ci.com/wolf1986/log_utils)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/log-utils)
+![PyPI](https://img.shields.io/pypi/v/log-utils)
+
+# log_utils_sdk - Utils for the generic python logging package
+
+## Continuous Integration
+
+- Tests are being executed continuously thanks to [TravisCI](https://app.travis-ci.com/github/wolf1986/log_utils)
+- Executed automatically for master branch & pull-requests
+
+## Module - LogHelper
+
+**Sample:**  
+Create a preconfigured logger format that supports colors (using colorama & colorlog packages)
+
+```python
+import logging
+from log_utils_sdk.helper import LogHelper
+
+logger = logging.getLogger()
+logger.addHandler(LogHelper.generate_color_handler())
+logger.setLevel(logging.INFO)
+
+logger.debug('Sample Message')
+logger.info('Sample Message, generated timestamp: ' + LogHelper.timestamp(with_ms=True))
+logger.warning('Sample Message')
+logger.error('Sample Message')
+logger.critical('Sample Message')
+```
+
+**Expected output:**
+
+```
+2018-12-22 12:12:23,518 root: INFO Sample Message, using timestamp: 20181222_121223.518
+2018-12-22 12:12:23,518 root: WARNING Sample Message
+2018-12-22 12:12:23,518 root: ERROR Sample Message
+2018-12-22 12:12:23,518 root: CRITICAL Sample Message
+```
+
+## Module - DataLogger
+
+DataLogger implements a Logger in every sense, but adds to it the ability to receive the **optional** kwarg: `data=...`,
+if such arg is received, then it might be processesed by the logger for future reference.
+
+**Features**:
+
+1. The data will be saved only if the log level is matched (same as the logged message)
+2. `data` may also be of type `Callable` - to prevent generation of data when loglevel is not matched.
+   e.g. `..., data=lambda: generate_my_matplotlib_figure()`
+3. `data` is a Python object that needs to be converted to `bytes`. See available converters ():
+    1. Pure Python - TextConverter, BinaryConverter, PickleConverter
+    2. Contribute to other libraries - NumpyImageConverter, MatplotlibConverter, PlotlyConverter
+4. `bytes` converted from the `data` object are handled by DataHandlers (similarly to regular logger Handlers).
+5. A useful handler exists (`SaveToDirHandler`), but others can be implemented for other purposes such as sending to a
+   server.
+
+> **Note:** Even though the module contains converters for Matplotlib and NumPy, they are only required if the user wishes to use them, so in order to successfully import these converters make sure that you have matplotlib and numpy installed.
+
+**Sample - Nominal use case:**
+
+```python
+"""  
+Internal components are responsible for their logs, the user of those components is responsible 
+for handlers of the log (both text handlers such as stdout / file, and data loggers), and the 
+location for writing data files created by the log. 
+"""
+
+import logging
+from log_utils_sdk.helper import LogHelper
+from log_utils_sdk.data_logger import DataLogger
+from log_utils_sdk.data_logger.converter_numpy_image import NumpyImageConverter
+from log_utils_sdk.data_logger.converter_matplotlib import MatplotlibConverter
+from log_utils_sdk.data_logger.handlers import SaveToDirHandler
+
+# Configure a data logger - Where to save, and what conversion methods to use, propagate to text logger  
+root_logger = logging.getLogger()
+root_logger.addHandler(LogHelper.generate_color_handler())
+
+logger = DataLogger('TestScript', logging.DEBUG)
+logger.addHandler(
+    SaveToDirHandler(path_dir_logs)
+        .addConverter(MatplotlibConverter())
+        .addConverter(NumpyImageConverter())
+)
+logger.parent = logger_root
+
+# Log data, repeat with different settings  
+obj = DemoComponent()
+obj.logger.parent = logger
+
+logger.info('About to demo using default settings')
+obj.some_method()
+
+
+class DemoComponent:
+    def __init__(self) -> None:
+        self.logger = DataLogger(name='DemoComponent')
+
+    def some_method(self):
+        self.logger.warning('TEST Warning')
+        self.logger.warning('TEST Data Warning', data=lambda: 'Some text contents')
+        self.logger.error('TEST Error')
+
+        self.logger.info('About to generate and dump some string data')
+        self.logger.debug('Some string data', data=lambda: 'File Contents\nLine 2')
+
+        self.logger.info('About to dump some binary data')
+        self.logger.debug('Some binary data', data=b'File Contents\nLine 2')
+
+        self.logger.info('About to generate and dump some NumPy data')
+        np_array = np.array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
+        self.logger.debug('Some numpy raw', data=np_array)
+        self.logger.debug('Some numpy bytes', data=np_array.tobytes())
+
+        self.logger.info('About to generate and dump a matplotlib figure')
+        self.logger.debug('Matplotlib Figure', data=lambda: self.figure_visualization())
+
+        self.logger.info('About to generate and dump a numpy image (50x50 gradient image)')
+        self.logger.debug('Numpy image', data=lambda: np.meshgrid(range(0, 250, 5), range(50))[0])
+
+    @staticmethod
+    def figure_visualization():
+        np.random.seed(0)
+
+        # example data
+        mu = 100  # mean of distribution
+        sigma = 15  # standard deviation of distribution
+        x = mu + sigma * np.random.randn(437)
+
+        num_bins = 50
+        fig, ax = pyplot.subplots()
+
+        # the histogram of the data
+        n, bins, patches = ax.hist(x, num_bins, density=1)
+
+        # add a 'best fit' line
+        y = mlab.normpdf(bins, mu, sigma)
+        ax.plot(bins, y, '--')
+        ax.set_xlabel('Smarts')
+        ax.set_ylabel('Probability density')
+        ax.set_title(r'Histogram of IQ: $\mu=100$, $\sigma=15$')
+
+        # Tweak spacing to prevent clipping of ylabel
+        fig.tight_layout()
+
+        return fig
+```
+
+**Expected output:**
+
+```
+2018-12-22 14:15:00,401 TestScript: INFO About to demo using default settings
+2018-12-22 14:15:00,401 DemoComponent: WARNING TEST Warning
+2018-12-22 14:15:00,401 DemoComponent: WARNING TEST Data Warning (No supported converters)
+2018-12-22 14:15:00,401 DemoComponent: ERROR TEST Error
+2018-12-22 14:15:00,403 DemoComponent: INFO About to generate and dump some string data
+2018-12-22 14:15:00,403 DemoComponent: DEBUG Some string data (No supported converters)
+2018-12-22 14:15:00,403 DemoComponent: INFO About to dump some binary data
+2018-12-22 14:15:00,403 DemoComponent: DEBUG Some binary data (No supported converters)
+2018-12-22 14:15:00,403 DemoComponent: INFO About to generate and dump some NumPy data
+2018-12-22 14:15:00,403 DemoComponent: DEBUG Some numpy raw (No supported converters)
+2018-12-22 14:15:00,403 DemoComponent: DEBUG Some numpy bytes (No supported converters)
+2018-12-22 14:15:00,403 DemoComponent: INFO About to generate and dump a matplotlib figure
+2018-12-22 14:15:00,965 DemoComponent: DEBUG Matplotlib Figure (Saved to: "C:\Users\wolf1\AppData\Local\Temp\tmp8fne_uz5\20181222_141500.889 DEBUG Matplotlib Figure.png"); I/O: 0.075 [sec]
+2018-12-22 14:15:00,965 DemoComponent: INFO About to generate and dump a numpy image (50x50 gradient image)
+2018-12-22 14:15:00,967 DemoComponent: DEBUG Numpy image (Saved to: "C:\Users\wolf1\AppData\Local\Temp\tmp8fne_uz5\20181222_141500.965 DEBUG Numpy image.png"); I/O: 0.001 [sec]
+```
+
+**Visit the tests for more:**
+
+- TextConverter
+- BinaryConverter
+- PickleConverter
+
+## Module - DataLogger.contrib
+
+In addition to Matplotlib figures and NumPy images which are supported by default, the contrib module contains
+additional adapters to various frameworks.
+
+- **Plotly -** Generated figures can be saved as `.html` files for later preview in the browser. Use
+  the `PlotlyConverter()` from `log_utils.data_logger.contrib.plotly_converter`
+
+### Sample - Plotly
+
+```python
+import shutil
+
+import numpy as np
+import logging
+from pathlib import Path
+from tempfile import mkdtemp
+from unittest import TestCase
+
+from log_utils_sdk.data_logger import DataLogger
+
+from log_utils_sdk.data_logger.contrib.plotly_converter import PlotlyConverter, PlotlyFigure
+from log_utils_sdk.data_logger.handlers import SaveToDirHandler
+from log_utils_sdk.helper import LogHelper
+
+
+class TestPlotlyConverter(TestCase):
+    @classmethod
+    def get_default_grid_settings(cls, title):
+        axis = dict(
+            showbackground=True,
+            backgroundcolor="rgb(230, 230,230)",
+            gridcolor="rgb(255, 255, 255)",
+            zerolinecolor="rgb(255, 255, 255)"
+        )
+
+        layout = dict(
+            title=title,
+            font=dict(family='Balto'),
+            showlegend=False,
+            width=800,
+            height=800,
+            scene=dict(
+                xaxis=axis,
+                yaxis=axis,
+                zaxis=axis,
+                aspectratio=dict(
+                    x=1,
+                    y=1,
+                    z=1
+                )
+            )
+        )
+
+        return layout
+
+    def test_save_ones_volume(self):
+        """
+            Note: For nosetest: Run with --nocapture
+        """
+
+        path_dir_logs = Path(mkdtemp())
+
+        try:
+            logger = DataLogger('TestLogger', logging.INFO)
+
+            logger.addHandler(SaveToDirHandler(path_dir_logs).addConverter(PlotlyConverter()))
+            logger.addHandler(LogHelper.generate_color_handler())
+
+            meshes = {
+                'i': np.array([2, 2]), 'showscale': False, 'opacity': 0.3, 'k': np.array([0, 1]),
+                'z': np.array([1., 1., 1., 1.], dtype=np.float32), 'name': '',
+                'y': np.array([0., 0., 1., 1.], dtype=np.float32),
+                'colorscale': [[0, 'rgb(6, 236, 35)'], [1.0, 'rgb(6, 236, 35)']],
+                'x': np.array([0., 1., 0., 1.], dtype=np.float32), 'type': 'mesh3d', 'j': np.array([1, 3]),
+                'reversescale': False,
+                'intensity': np.array([-0., -0.13533528, -0., -0.04978707], dtype=np.float32)
+            }
+
+            logger.info(
+                'Plotly figure sample',
+                data=PlotlyFigure(data=[meshes], layout=self.get_default_grid_settings("test"))
+            )
+
+            self.assertTrue(
+                len(list(path_dir_logs.glob('*.html'))) == 1
+            )
+
+        finally:
+            shutil.rmtree(str(path_dir_logs))
+```
+
+