Create README and configure tox properly

Author: mortenlj

README.rst

@@ -0,0 +1,38 @@
+=============
+FIAAS Logging
+=============
+
+This library configures logging according to the current FIAAS recomended format.
+
+Usage::
+
+    from fiaas_logging import init_logging
+
+    init_logging(format="json")
+
+
+This would configure your application to emit JSON formatted logs on STDOUT.
+
+Available options (all are keyword arguments to `init_logging`):
+
+
+====== =============== =================================================
+Key    Possible values Meaning
+====== =============== =================================================
+format `json`/`plain`  Select either JSON logging, or plain text logging
+debug  `True`/`False`  Enable debug logging
+====== =============== =================================================
+
+The plain format contains the fields timestamp, level name, message, logger name, and thread name.
+In the json format, there are more fields, with more detail. The fields in the json output are:
+
+============ =======================================================================
+Name         Meaning
+============ =======================================================================
+@timestamp   Timestamp of message
+@version     Version, legacy field to support ELK stack at FINN (to be removed?)
+LocationInfo A structure describing the code location that logged this message
+message      The actual log message
+extras       A structure containing extra fields. Used for thread context
+throwable    A formatted stacktrace if the log message is the result of an exception
+============ =======================================================================

setup.cfg

@@ -2,7 +2,7 @@
 test=pytest
 
 [tool:pytest]
-addopts = --junitxml=build/reports/tests/junit.xml --cov=fiaas_logging --cov-report html --cov-report term --cov-report xml
+addopts = --junitxml=build/reports/tests/junit.xml
 
 [coverage:html]
 directory=build/reports/coverage

setup.py

@@ -25,8 +25,6 @@
 ]
 
 TESTS_REQ = [
-    "tox == 3.14.5",
-    "tox-venv==0.4.0",
     "pytest == 4.6.9",
     "pytest-cov == 2.8.1",
     "pytest-html == 1.22.1",

tox.ini

@@ -1,22 +1,27 @@
 [tox]
 envlist = py27,py36,py37,py38
 skip_missing_interpreters=True
+minversion=3.14
+requires=
+    tox-venv
 
 [testenv]
 usedevelop=True
+download=True
 deps=.[dev]
 setenv =
     TMP = {envtmpdir}
 passenv =
     HOME
 commands=prospector
-         py.test
+         !py38: py.test
+         py38: py.test --cov=fiaas_logging --cov-report html --cov-report term --cov-report xml
 
 [testenv:coverage]
 usedevelop=True
 deps=.[dev,codacy]
 passenv =
     HOME
     CODACY_PROJECT_TOKEN
-commands=py.test
+commands=py.test --cov=fiaas_logging --cov-report html --cov-report term --cov-report xml
          python-codacy-coverage -r ./build/reports/coverage.xml