Uploaded to PyPi

Author: Ivaylo Korakov

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, kubernetes
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -3,7 +3,7 @@ This Python module makes logging easy for your application.
 The logger outputs JSON formatted logs for ingesting into Elastic.  
 
 The module implements the ECS (Elastic Common Schema) specification that
-can be found at for quick reference:  
+can be found at for quick reference: 
 [ECS Field Reference](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html#ecs-field-reference)
 
 ## Usage
@@ -12,8 +12,12 @@ can be found at for quick reference:
 from kubi_ecs_logger import Logger, Severity
 
 # Set some defaults in the start of your app
+# If in development mode the lib will output formatted json.
 Logger().dev = True
+# The minimum level of severity for outputing. E.g. If set to INFO then DEBUG logs will not 
+# be printed to standard out
 Logger().severity_output_level = Severity.INFO
+# Set default key/value pairs for the different classes that will always be appended before final output
 Logger().defaults = {
     "event": {
         "test": "test value"
@@ -55,7 +59,7 @@ Logger() \
 #   "event": {
 #     "action": "request received",
 #     "category": "requests",
-#     "test": "test value"
+#     "test": "test value"  # From defaults
 #   },
 #   "httpresponse": {
 #     "status_code": "200"

setup.cfg

@@ -0,0 +1,3 @@
+# Inside of setup.cfg
+[metadata]
+description-file = README.md

setup.py

@@ -101,10 +101,10 @@
 
         # Indicate who your project is intended for
         'Intended Audience :: Developers',
-        'Topic :: Software Development :: Logging Tools',
+        'Topic :: System :: Logging',
 
         # Pick your license as you wish
-        'License :: Apache2 License',
+        'License :: OSI Approved :: BSD License',
 
         # Specify the Python versions you support here. In particular, ensure
         # that you indicate whether you support Python 2, Python 3 or both.
@@ -197,10 +197,8 @@
     # issues, where the source is hosted, where to say thanks to the package
     # maintainers, and where to support the project financially. The key is
     # what's used to render the link text on PyPI.
-    # project_urls={  # Optional
-    #     'Bug Reports': 'https://github.com/pypa/sampleproject/issues',
-    #     'Funding': 'https://donate.pypi.org',
-    #     'Say Thanks!': 'http://saythanks.io/to/example',
-    #     'Source': 'https://github.com/pypa/sampleproject/',
-    # },
+    project_urls={  # Optional
+        "Kumina": 'https://kumina.nl/index',
+        'Source': 'https://github.com/kumina/kubi_ecs_logger'
+    }
 )