Basic project setup

Author: mortenlj

.gitignore

@@ -1,48 +1,4 @@
 # Created by .ignore support plugin (hsz.mobi)
-### Backup template
-*.bak
-*.gho
-*.ori
-*.orig
-*.tmp
-
-### Vim template
-# Swap
-[._]*.s[a-v][a-z]
-[._]*.sw[a-p]
-[._]s[a-rt-v][a-z]
-[._]ss[a-gi-z]
-[._]sw[a-p]
-
-# Session
-Session.vim
-Sessionx.vim
-
-# Temporary
-.netrwhist
-*~
-# Auto-generated tag files
-tags
-# Persistent undo
-[._]*.un~
-
-### Go template
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
-
-# Test binary, built with `go test -c`
-*.test
-
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
-
-# Dependency directories (remove the comment below to include it)
-# vendor/
-
 ### Python template
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -169,6 +125,20 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+### VirtualEnv template
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+.Python
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ll]ib64
+[Ll]ocal
+[Ss]cripts
+pyvenv.cfg
+.venv
+pip-selfcheck.json
+
 ### Linux template
 *~
 
@@ -184,57 +154,6 @@ dmypy.json
 # .nfs files are created when an open file is removed but is still being accessed
 .nfs*
 
-### Emacs template
-# -*- mode: gitignore; -*-
-*~
-\#*\#
-/.emacs.desktop
-/.emacs.desktop.lock
-*.elc
-auto-save-list
-tramp
-.\#*
-
-# Org-mode
-.org-id-locations
-*_archive
-
-# flymake-mode
-*_flymake.*
-
-# eshell files
-/eshell/history
-/eshell/lastdir
-
-# elpa packages
-/elpa/
-
-# reftex files
-*.rel
-
-# AUCTeX auto folder
-/auto/
-
-# cask packages
-.cask/
-dist/
-
-# Flycheck
-flycheck_*.el
-
-# server auth directory
-/server/
-
-# projectiles files
-.projectile
-
-# directory configuration
-.dir-locals.el
-
-# network security
-/network-security.data
-
-
 ### macOS template
 # General
 .DS_Store
@@ -263,39 +182,6 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-### VisualStudioCode template
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-
-### Windows template
-# Windows thumbnail cache files
-Thumbs.db
-Thumbs.db:encryptable
-ehthumbs.db
-ehthumbs_vista.db
-
-# Dump file
-*.stackdump
-
-# Folder config file
-[Dd]esktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msix
-*.msm
-*.msp
-
-# Windows shortcuts
-*.lnk
-
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
@@ -307,9 +193,6 @@ $RECYCLE.BIN/
 # CMake
 cmake-build-*/
 
-# Mongo Explorer plugin
-.idea/**/mongoSettings.xml
-
 # File-based project format
 *.iws
 

.prospector.yaml

@@ -0,0 +1,34 @@
+strictness: high
+test-warnings: true
+doc-warnings: false
+
+ignore-paths:
+  - build
+  - .git
+  - __pycache__
+  - .eggs
+  - dist
+  - .tox
+  - .cachedocs
+
+pep8:
+  options:
+    max-line-length: 120
+
+mccabe:
+  max-complexity: 10
+
+pylint:
+  run: false
+
+pyroma:
+  run: false
+
+frosted:
+  run: false
+
+vulture:
+  run: false
+
+pep257:
+  run: false

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2016-2019 The FIAAS Authors
+   Copyright 2017 FINN.no AS
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -0,0 +1,123 @@
+#!/usr/bin/env python
+# -*- coding: utf-8
+
+# Copyright 2017-2019 The FIAAS Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import absolute_import
+
+import threading
+import datetime
+import json
+import logging
+import sys
+
+__version__ = '0.1.0'
+LOG_EXTRAS = threading.local()
+
+
+class FiaasFormatter(logging.Formatter):
+    UNWANTED = (
+        "msg", "args", "exc_info", "exc_text", "levelno", "created", "msecs", "relativeCreated", "funcName",
+        "filename", "lineno", "module")
+    RENAME = {
+        "levelname": "level",
+        "threadName": "thread",
+        "name": "logger",
+    }
+
+    def format(self, record):
+        fields = vars(record).copy()
+        fields["@timestamp"] = self.format_time(record)
+        fields["@version"] = 1
+        fields["LocationInfo"] = self._build_location(fields)
+        fields["message"] = record.getMessage()
+        fields["extras"] = getattr(record, "extras", {})
+        if "exc_info" in fields and fields["exc_info"]:
+            fields["throwable"] = self.formatException(fields["exc_info"])
+        for original, replacement in self.RENAME.items():
+            fields[replacement] = fields.pop(original)
+        for unwanted in self.UNWANTED:
+            fields.pop(unwanted)
+        return json.dumps(fields, default=self._default_json_default)
+
+    @staticmethod
+    def format_time(record):
+        """ELK is strict about it's timestamp, so use more strict ISO-format"""
+        dt = datetime.datetime.fromtimestamp(record.created)
+        return dt.isoformat()
+
+    @staticmethod
+    def _default_json_default(obj):
+        """
+        Coerce everything to strings.
+        All objects representing time get output as ISO8601.
+        """
+        if isinstance(obj, (datetime.datetime, datetime.date, datetime.time)):
+            return obj.isoformat()
+        else:
+            return str(obj)
+
+    @staticmethod
+    def _build_location(fields):
+        return {
+            "method": fields["funcName"],
+            "file": fields["filename"],
+            "line": fields["lineno"],
+            "module": fields["module"]
+        }
+
+
+class ExtraFilter(logging.Filter):
+    def filter(self, record):
+        extras = {}
+        for key, value in vars(LOG_EXTRAS).items():
+            extras[key] = value
+        record.extras = extras
+        return 1
+
+
+def set_extras(**kwargs):
+    for key, value in kwargs.items():
+        setattr(LOG_EXTRAS, key, value)
+
+
+def init_logging(debug=False, format="plain"):
+    """Set up logging system, according to best practice for cloud
+
+    :param debug: Enable debug logging
+    :param format: Select log format. Available options are "json" and "plain".
+    """
+    root = logging.getLogger()
+    root.setLevel(logging.INFO)
+    if debug:
+        root.setLevel(logging.DEBUG)
+    root.addHandler(_create_default_handler(format))
+
+
+def _create_default_handler(format):
+    handler = logging.StreamHandler(sys.stdout)
+    handler.addFilter(ExtraFilter())
+    if _json_format(format):
+        handler.setFormatter(FiaasFormatter())
+    elif _plain_format(format):
+        handler.setFormatter(logging.Formatter("[%(asctime)s|%(levelname)7s] %(message)s [%(name)s|%(threadName)s]"))
+    return handler
+
+
+def _json_format(format):
+    return format == "json"
+
+
+def _plain_format(format):
+    return format == "plain"

README.rst

@@ -0,0 +1 @@
+-e .[dev]

fiaas_logging/__init__.py

@@ -0,0 +1,11 @@
+[aliases]
+test=pytest
+
+[tool:pytest]
+addopts = --junitxml=build/reports/tests/junit.xml --cov=fiaas_logging --cov-report html --cov-report term --cov-report xml
+
+[coverage:html]
+directory=build/reports/coverage
+
+[coverage:xml]
+output=build/reports/coverage.xml