Merge pull request #109 from flask-dashboard/development

Development

.travis.yml

@@ -1,16 +1,18 @@
 language: python
 python:
-  - "2.7"
-  - "3.3"
-  - "3.4"
-  - "3.5"
-  - "3.6"
-
+- '2.7'
+- '3.3'
+- '3.4'
+- '3.5'
+- '3.6'
 install:
-  - pip install codecov
-
+- pip install codecov
 script:
-  - coverage run setup.py test
-
+- coverage run setup.py test
 after_success:
-  - codecov
+- codecov
+deploy:
+  provider: pypi
+  user: flyingbird95
+  password:
+    secure: P3BqSjdTww+I9tnpurGTPSTEQUvl9ki3BxvV3ndpLqvd+4rE5njjuaWuinSSjNqNDUmWhV9PfxfzMoXuRJZHPUCEfF5PrJ3aH4tQcuP/83PAdjGAokzHeByLJsYhbcPKWqon/j1syynAQtOpM//ow8qK4c/tE3I1mP1YQujp3R0SAA4KMHtZ+ZhMcyXFwMprX6dfcdv7w/H0zxcQhVJn5vZmiPMmkwRXhNEQ7jif8PVpGdGYBtX/hySaV2WTEZNaKyUvrvK6vxzPjoaT7JBrHrCcasefUy3/9oVX+bZHoUTd1OgrwCYehAWr59l5Mk+LJMgcMb6DaVu6KXDJSQ5NNFonpIJLl+HIGyz+EXsdb3ZgPwq395RNDYX1VrKA1JOKBN/a6mlWPpV4JyNeTyYFIGJdbZYbaLgc080pA/IN8K3EdAO1Ulze9gVFcOdLYbUWWEy4JHcKoaL9+FIPw+02HI980r8X9XdYdeMBll+hGiyIoV4OGisacjdb3CNbOCc9MmsKCieJJe6ee1VjUYgFEFcqr6cFXDH5rFgLwjNL2ofcrItic30kdmf/Pk31cj8aPMmR/hFYPiOGx+mpMI94vdRhfU89JQqAvvFWFJp5+fA+TBRnP+4APrCEcvgr95Wp0S+GLP6t0MGcQp7EaloedKbWi0qvVRaaLU6X2NwenpM=

MANIFEST.in

@@ -3,4 +3,4 @@ recursive-include flask_monitoringdashboard/templates *
 recursive-include flask_monitoringdashboard/test *
 include requirements.txt
 include README.md
-include CHANGELOG.rst
+include docs/changelog.rst

docs/changelog.rst

@@ -1 +1,64 @@
-.. include:: ../CHANGELOG.rst
+Change Log
+=========================================================================
+
+All notable changes to this project will be documented in this file.
+This project adheres to `Semantic Versioning <http://semver.org/>`_.
+Please note that the changes before version 1.10.0 have not been documented.
+
+
+Unreleased
+----------
+Changed
+
+- Added mean CPU
+
+- Updated documentation
+
+- Updated the Test-Monitoring initialization
+
+
+v1.12.0
+-------
+Changed
+
+- Removed two graphs: hits per hour and execution time per hour
+
+- New template design
+
+- Refactored backhand of the code
+
+- Updated Bootstrap 3.0 to 4.0
+
+- Setup of Code coverage
+
+
+v1.11.0
+-------
+Changed
+
+- Added new graph: Version usage
+
+- Added column (Hits in past 7 days) in Measurements Overview
+
+- Fixed bug with configuration
+
+- Changed rows and column in outlier-table
+
+- Added TODO List
+
+- Updated functionality to retrieve the stacktrace of an Outlier
+
+- Fixed bug with white colors from the config option
+
+
+v1.10.0
+----------
+Changed
+
+- Added security for automatic endpoint-data retrieval.
+
+- Added test for export_data-endpoints
+
+- Added MIT License.
+
+- Added documentation

docs/conf.py

@@ -6,6 +6,8 @@
 # full list see the documentation:
 # http://www.sphinx-doc.org/en/stable/config
 import pkg_resources
+import datetime
+from email import message_from_string
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -15,13 +17,14 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('../flask-monitoringdashboard'))	
-
+data = message_from_string(pkg_resources.require("Flask-MonitoringDashboard")[0].get_metadata('PKG-INFO'))
 
 # -- Project information -----------------------------------------------------
 
 project = 'Flask-MonitoringDashboard'
-copyright = '2018, Patrick Vogel & Thijs Klooster'
-author = 'Patrick Vogel & Thijs Klooster'
+author = data['Author']
+copyright = '{}, {}'.format(datetime.datetime.now().year, author)
+
 
 version = pkg_resources.require("Flask-MonitoringDashboard")[0].version
 release = pkg_resources.require("Flask-MonitoringDashboard")[0].version
@@ -138,7 +141,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'Flask-MonitoringDashboard.tex', 'Flask-MonitoringDashboard Documentation',
-     'Patrick Vogel \\& Thijs Klooster', 'manual'),
+     author, 'manual'),
 ]
 
 

docs/configuration.rst

@@ -1,13 +1,13 @@
 Configuration
 =============
-Once you have successfully installed the Flask Monitoring Dashboard from `this page <installation.html>`_,
-you can use the advanced features by correctly configuration the dashboard.
+Once you have successfully installed the Flask Monitoring Dashboard with information from 
+`this page <installation.html>`_, you can use the advanced features by correctly configuring the Dashboard.
 
 Using a configuration file
 --------------------------
-You can use a configuration file for all options below.
+You can use a single configuration file for all options below.
 This is explained in the following section.
-In order to configure the dashboard with the configuration-file, you can use the following function:
+In order to configure the Dashboard with a configuration-file, you can use the following function:
 
 .. code-block:: python
 
@@ -41,12 +41,12 @@ The line should then be:
 
    dashboard.config.init_from(envvar='DASHBOARD_CONFIG')
 
-This will configure the dashboard based on the file provided in the environment variable called `DASHBOARD_CONFIG`.
+This will configure the Dashboard based on the file provided in the environment variable called `DASHBOARD_CONFIG`.
 
 The content of the configuration file
 -------------------------------------
-Once the setup is done, a configuration file ('config.cfg') should be set next to the python file that contains
-the entry point of the app. The following things can be configured:
+Once the setup is complete, a configuration file (e.g. 'config.cfg') should be set next to the python file that 
+contains the entry point of the app. The following things can be configured:
 
 .. code-block:: python
 
@@ -62,19 +62,20 @@ the entry point of the app. The following things can be configured:
    OUTLIER_DETECTION_CONSTANT=2.5
    DASHBOARD_ENABLED = True
    TEST_DIR=/<path to your project>/tests/
-   COLORS={'main':[0,97,255], 'static':[255,153,0]}
+   COLORS={'main':'[0,97,255]',
+           'static':'[255,153,0]'}
 
 This might look a bit overwhelming, but the following list explains everything in detail:
 
-- **APP_VERSION:** The version of the app that you use.
+- **APP_VERSION:** The version of the application that you use.
   Updating the version helps in showing differences in execution times of a function over a period of time.
 
-- **CUSTOM_LINK:** The dashboard can be visited at localhost:5000/{{CUSTOM_LINK}}.
+- **CUSTOM_LINK:** The Dashboard can be visited at localhost:5000/{{CUSTOM_LINK}}.
 
 - **DATABASE:** Suppose you have multiple projects where you're working on and want to separate the results.
   Then you can specify different database_names, such that the result of each project is stored in its own database.
 
-- **USERNAME** and **PASSWORD:** Must be used for logging into the dashboard.
+- **USERNAME** and **PASSWORD:** Must be used for logging into the Dashboard.
   Thus both are required.
 
 - **GUEST_USERNAME** and **GUEST_PASSWORD:** A guest can only see the results, but cannot configure/download any data.
@@ -87,10 +88,10 @@ This might look a bit overwhelming, but the following list explains everything i
 
 - **OUTLIER_DETECTION_CONSTANT:** When the execution time is more than this :math:`constant * average`,
   extra information is logged into the database.
-  A default value for this variable is :math:`2.5`, but can be changed in the config-file.
+  A default value for this variable is :math:`2.5`.
 
 - **OUTLIERS_ENABLED:** Whether you want to collect information about outliers. If you set this to true,
-  the expected overhead is a bit larger, as you can find
+  the expected overhead of the Dashboard is a bit larger, as you can find
   `here <https://github.com/flask-dashboard/Testing-Dashboard-Overhead>`_.
 
 - **TEST_DIR:** Specifies where the unit tests reside. This will show up in the configuration in the Dashboard.
@@ -101,9 +102,10 @@ This might look a bit overwhelming, but the following list explains everything i
 
   .. code-block:: python
 
-     COLORS={'main':[0,97,255], 'static':[255,153,0]}
+     COLORS={'main':'[0,97,255]', 
+             'static':'[255,153,0]'}
 
 What have you configured?
 -------------------------
-A lot of configuration options, but you might wonder what functionality is now supported in your Flask Monitoring Dashboard?
+A lot of configuration options, but you might wonder what functionality is now supported in your Flask application?
 Have a look at `this file <functionality.html>`_ to find the answer.

docs/contact.rst

@@ -1,6 +1,36 @@
 Contact
 =======
-In this file, you can find information to find us.
+This page provides information about how to ask a question, or post an issue.
+
+Developing-team
+---------------
+Currently, the team consists of three active developers:
+
++------------+----------------------------------------------------------------------+
+| |Picture1| | | **Patrick Vogel**                                                  |
+|            | |                                                                    |
+|            | | Core developer                                                     |
+|            | |                                                                    |
+|            | | **E-mail:** `patrickvogel@live.nl <mailto:patrickvogel@live.nl>`_. |
++------------+----------------------------------------------------------------------+
+| |Picture2| | | **Thijs Klooster**                                                 |
+|            | |                                                                    |
+|            | | Test Monitor Specialist                                            |
++------------+----------------------------------------------------------------------+
+| |Picture3| | | **Bogdan Petre**                                                   |
+|            | |                                                                    |
+|            | | Outlier Specialist                                                 |
++------------+----------------------------------------------------------------------+
+
+.. |Picture1| image:: https://avatars2.githubusercontent.com/u/17162650?s=460&v=4
+              ..:width: 100px
+
+.. |Picture2| image:: https://avatars3.githubusercontent.com/u/17165311?s=400&v=4
+              ..:width: 100px
+
+.. |Picture3| image:: https://avatars2.githubusercontent.com/u/7281856?s=400&v=4
+              ..:width: 100px
+
 
 Found a bug?
 ------------