chg: added .pre-commit-config.yaml

Author: cedricbonhomme

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
+    hooks:
+      - id: pyupgrade
+        args: ["--py37-plus"]
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.0.1
+    hooks:
+      - id: reorder-python-imports
+        additional_dependencies: ["setuptools>60.9"]
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-bugbear
+          - flake8-implicit-str-concat
+        args: ["--max-line-length=127"]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: fix-byte-order-marker
+      - id: trailing-whitespace
+      - id: end-of-file-fixer

CONTRIBUTING.md

@@ -1,6 +1,15 @@
 You are welcome to contribute to the MONARC Stats Service project.
 There are many ways to contribute and participate.
 
+Before starting to contribute please install the Git hook scripts:
+
+```bash
+$ git clone https://github.com/monarc-project/stats-service
+$ cd stats-service/
+$ poetry install
+$ pre-commit install
+```
+
 Feel free to fork the code, play with it, make some patches and send us the pull
 requests.
 

COPYING

@@ -658,4 +658,4 @@ specific requirements.
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU AGPL, see
-<http://www.gnu.org/licenses/>.
+<http://www.gnu.org/licenses/>.

docs/admin.rst

@@ -43,7 +43,7 @@ Update Stats Service
 
     $ curl -H  "X-API-KEY: 5USubuFK_FXB7fXoMq_Nt0CHRo9SxQW0J_FarVG5fCJmXckz6T1qgE2wtV_aFiGTGvBi1Xr45-CayfgpC-_MMA"  http://127.0.0.1:5000/admin/update.json
     {
-      "output": "b'Already up to date.\\n'b'\\n'b'> stats-service@0.4.0 postinstall\\n'b'> cd statsservice/static/ ; ln -sf ../../node_modules npm_components\\n'b'\\n'b'\\n'b'added 11 packages, and audited 12 packages in 777ms\\n'b'\\n'b'2 packages are looking for funding\\n'b'  run `npm fund` for details\\n'b'\\n'b'found 0 vulnerabilities\\n'b'Installing dependencies from lock file\\n'b'\\n'b'No dependencies to install or update\\n'b'\\n'b'Installing the current project: statsservice (0.4.0)\\n'b'\\xe2\\x9c\\xa8 \\xf0\\x9f\\x8c\\x9f \\xe2\\x9c\\xa8\\n'b'\\x1b[0;32mStats Service updated. You can now restart the service.\\x1b[0m Examples:\\n'b'    sudo systemctl restart statsservice.service\\n'b'    sudo systemctl restart apache2.service\\n'", 
+      "output": "b'Already up to date.\\n'b'\\n'b'> stats-service@0.4.0 postinstall\\n'b'> cd statsservice/static/ ; ln -sf ../../node_modules npm_components\\n'b'\\n'b'\\n'b'added 11 packages, and audited 12 packages in 777ms\\n'b'\\n'b'2 packages are looking for funding\\n'b'  run `npm fund` for details\\n'b'\\n'b'found 0 vulnerabilities\\n'b'Installing dependencies from lock file\\n'b'\\n'b'No dependencies to install or update\\n'b'\\n'b'Installing the current project: statsservice (0.4.0)\\n'b'\\xe2\\x9c\\xa8 \\xf0\\x9f\\x8c\\x9f \\xe2\\x9c\\xa8\\n'b'\\x1b[0;32mStats Service updated. You can now restart the service.\\x1b[0m Examples:\\n'b'    sudo systemctl restart statsservice.service\\n'b'    sudo systemctl restart apache2.service\\n'",
       "result": "OK"
     }
 

docs/architecture.rst

@@ -1,7 +1,7 @@
 Architecture
 ============
 
-High level architecture 
+High level architecture
 -----------------------
 
 .. image:: _static/architecture-stats-organization-level.png
@@ -113,7 +113,7 @@ Scenario 2
 
 The Stats Service is installed on a dedicated server.
 
-     
+
 Scenario 3
 ''''''''''
 
@@ -138,9 +138,9 @@ Important notes
     `General Settings / Sharing statistics  <https://www.monarc.lu/documentation/user-guide/#global-dashboard>`_
     view of your MONARC instance
     (`see here <https://www.monarc.lu/documentation/user-guide/images/GlobalDashboardGlobalSetting.png>`_).
-    
+
     However, stats must always be collected in your local Stats Service instance.
-    This is required for the proper functioning of the global dashboard of your MONARC instance. 
+    This is required for the proper functioning of the global dashboard of your MONARC instance.
 
 
 .. note::

docs/command-line-interface.rst

@@ -268,7 +268,7 @@ Pulling data from a central stats server.
                          threat).  [required]
 
       --help             Show this message and exit.
-  
+
 
 Delete stats
 ~~~~~~~~~~~~

docs/conf.py

@@ -3,18 +3,14 @@
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
-
 # -- Path setup --------------------------------------------------------------
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
-
 # -- Project information -----------------------------------------------------
 
 project = "MONARC Stats Service"
@@ -105,15 +101,15 @@
     (
         "index",
         "MONARC_Stats_Service.tex",
-        u"MONARC Stats Service",
-        u"CASES Luxembourg",
+        "MONARC Stats Service",
+        "CASES Luxembourg",
         "howto",
     ),
 ]
 
 latex_show_urls = True
 latex_show_pagerefs = True
 
-ADDITIONAL_PREAMBLE = """
+ADDITIONAL_PREAMBLE = r"""
 \setcounter{tocdepth}{3}
 """

docs/index.rst

@@ -14,7 +14,7 @@ software which is providing:
   `MONARC <https://github.com/monarc-project/MonarcAppFO>`_ instances and to **return**
   these statistics with different filters and aggregation methods;
 * a dashboard that summarizes the **current cybersecurity landscape**. The charts are
-  based on the statistics collected. 
+  based on the statistics collected.
 
 This software can be deployed just next to a MONARC instance or on a
 dedicated server.

docs/installation.rst

@@ -310,7 +310,7 @@ Connect to the session:
             183221.statsservice      (02/25/21 10:56:59)     (Detached)
     1 Socket in /var/run/screen/S-cedric.
     $ screen -xS 183221.statsservice
-    $ 
+    $
 
 
 

docs/stats.rst

@@ -119,59 +119,59 @@ Risks
       "current": {
         "informational": {
           "High risks": {
-            "2020-10-01": 8.0, 
+            "2020-10-01": 8.0,
             "2020-10-12": 8.0
-          }, 
+          },
           "Low risks": {
-            "2020-10-01": 66.0, 
+            "2020-10-01": 66.0,
             "2020-10-12": 12.0
-          }, 
+          },
           "Medium risks": {
-            "2020-10-01": 27.0, 
+            "2020-10-01": 27.0,
             "2020-10-12": 27.0
           }
-        }, 
+        },
         "operational": {
           "High risks": {
-            "2020-10-01": 10.0, 
+            "2020-10-01": 10.0,
             "2020-10-12": 10.0
-          }, 
+          },
           "Low risks": {
-            "2020-10-01": 18.0, 
+            "2020-10-01": 18.0,
             "2020-10-12": 18.0
-          }, 
+          },
           "Medium risks": {
-            "2020-10-01": 0.0, 
+            "2020-10-01": 0.0,
             "2020-10-12": 0.0
           }
         }
-      }, 
+      },
       "residual": {
         "informational": {
           "High risks": {
-            "2020-10-01": 1.0, 
+            "2020-10-01": 1.0,
             "2020-10-12": 1.0
-          }, 
+          },
           "Low risks": {
-            "2020-10-01": 74.0, 
+            "2020-10-01": 74.0,
             "2020-10-12": 74.0
-          }, 
+          },
           "Medium risks": {
-            "2020-10-01": 26.0, 
+            "2020-10-01": 26.0,
             "2020-10-12": 26.0
           }
-        }, 
+        },
         "operational": {
           "High risks": {
-            "2020-10-01": 0.0, 
+            "2020-10-01": 0.0,
             "2020-10-12": 0.0
-          }, 
+          },
           "Low risks": {
-            "2020-10-01": 28.0, 
+            "2020-10-01": 28.0,
             "2020-10-12": 28.0
-          }, 
+          },
           "Medium risks": {
-            "2020-10-01": 0.0, 
+            "2020-10-01": 0.0,
             "2020-10-12": 0.0
           }
         }
@@ -185,25 +185,25 @@ Risks
     {
       "current": {
         "informational": {
-          "High risks": 8.0, 
-          "Low risks": 30.0, 
+          "High risks": 8.0,
+          "Low risks": 30.0,
           "Medium risks": 27.0
-        }, 
+        },
         "operational": {
-          "High risks": 10.0, 
-          "Low risks": 18.0, 
+          "High risks": 10.0,
+          "Low risks": 18.0,
           "Medium risks": 0.0
         }
-      }, 
+      },
       "residual": {
         "informational": {
-          "High risks": 1.0, 
-          "Low risks": 74.0, 
+          "High risks": 1.0,
+          "Low risks": 74.0,
           "Medium risks": 26.0
-        }, 
+        },
         "operational": {
-          "High risks": 0.0, 
-          "Low risks": 28.0, 
+          "High risks": 0.0,
+          "Low risks": 28.0,
           "Medium risks": 0.0
         }
       }