new release

Release v2.1.0

Author: djs0109

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.pre-commit-config.yaml

@@ -1,12 +1,28 @@
 exclude: '^static/[bootstrap|htmx]/'
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/psf/black
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
     rev: 24.1.1
     hooks:
-    -   id: black
+      - id: black
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.0.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [ commit-msg ]
+        args: [
+          "--force-scope",
+          "--verbose",
+          "--scopes",
+          "entirety,entities,users,subscriptions,smartdatamodels,devices,semantics"
+        ]

README.md

@@ -1,20 +1,59 @@
 # n5geh.tools.entirety
 
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
 [![semantic-release](https://github.com/N5GEH/n5geh.tools.entirety/actions/workflows/semantic-release.yml/badge.svg)](https://github.com/N5GEH/n5geh.tools.entirety/actions/workflows/semantic-release.yml)
 
+Entirety is a web-based graphical user interface (GUI) meant to provide easy access to some of FIWARE's Generic Enablers (GE) without requiring deeper knowledge on their APIs: Context Brokers like [Orion](https://fiware-orion.readthedocs.io/en/master/) and the [IoT Agent JSON](https://github.com/telefonicaid/iotagent-json/tree/master). 
+Entirety is python-based and relies on the [FIWARE Library for Python (FiLiP)](https://github.com/RWTH-EBC/FiLiP) for the communication with the GE APIs. 
+
+Entirety holds modules (as displayed on the left hand side of the GUI) providing features to perform CRUD (create, read, update, delete) operations to entities in the Context Broker, devices in the IoT Agent, and subscriptions / notifications to QuantumLeap or other applications. Furthermore, Entirety provides a graphical overview of the semantic relationships between entities in the Semantics module as well as a store for standardized data models that can be either created or imported from external sources, like the [Smart Data Models Program](https://smartdatamodels.org//) in the Data Models module.
+
+This project is currently in the process of contribution to FIWARE by the [Institute for Energy Efficient Buildings and Indoor Climate of RWTH Aachen University](https://www.ebc.eonerc.rwth-aachen.de/cms/~dmzz/e-on-erc-ebc/?lidx=1). You can find more GEs in the [FIWARE catalogue](https://github.com/Fiware/catalogue/).
+
+## Table of Contents
+
+- [n5geh.tools.entirety](#n5gehtoolsentirety)
+  - [Table of Contents](#table-of-contents)
+  - [Built With](#built-with)
+  - [Roadmap](#roadmap)
+  - [User Guide](#user-guide)
+  - [Deployment Guide](#deployment-guide)
+  - [Contributing](#contributing)
+  - [Development](#development)
+    - [Prerequisites](#prerequisites)
+      - [Installing dependencies](#installing-dependencies)
+      - [create .env File](#create-env-file)
+    - [Get started](#get-started)
+    - [Required](#required)
+    - [Optional](#optional)
+    - [OIDC](#oidc)
+  - [User and permissions model](#user-and-permissions-model)
+  - [Changelog](#changelog)
+  - [Contact](#contact)
+  - [License](#license)
+  - [Further project information](#further-project-information)
+  - [Acknowledgments](#acknowledgments)
+
 ## Built With
 
 - Django 4.1
 - Bootstrap 5.2
 - htmx 1.8.2
+- Python 3.8/3.9
 
 ## Roadmap
 Have a look at our [roadmap](./docs/ROADMAP.md) to see what features we plan to work on in the short and long run. We kindly invite you to participate in [discussions](https://github.com/N5GEH/n5geh.tools.entirety/discussions) about possible features as well.
-## Deployment
 
-To deploy the application please refer to
-our [deployment guide](https://github.com/N5GEH/n5geh.tutorials.entirety_step_by_step)
+## User Guide
+
+The [user guide](./docs/USERGUIDE.md) describes how the GUI works and guides you through the functionalities of Entirety.
+
+## Deployment Guide
+
+To deploy Entirety via docker, please, refer to our [deployment guide](https://github.com/N5GEH/n5geh.tutorials.entirety_step_by_step), that also gives an overview of the used environment variables.
+If you wish to deploy Entirety for development purposes on your local machine, you can follow the [development](#deployment) and [get started](#get-started) paragraphs.
+
 
 ## Contributing
 
@@ -49,7 +88,7 @@ pre-commit
   cp .env.EXAMPLE .env
 ```
 
-## Usage
+### Get started
 
 Migrate Database
 
@@ -118,7 +157,10 @@ See [changelog](./docs/CHANGELOG.md) for detailed overview of changes.
 
 ## License
 
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
+Entirety is licensed under the GPLv3 license [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE).
+
+Furthermore, the authors want to make the following statement:
+>Please note that software derived as a result of modifying the source code of the software in order to fix a bug or incorporate enhancements IS considered a derivative work of the product. Software that merely uses or aggregates (i.e. links to) an otherwise unmodified version of existing software IS NOT considered a derivative work.
 
 ## Further project information
 

app/Entirety/.env.EXAMPLE

@@ -50,8 +50,8 @@ OIDC_TOKEN_ROLE_PATH="$.entirety.roles"
 
 # FIWARE
 CB_URL=http://localhost:1026
-IOTA_URL="http://localhost:4041"
-QL_URL="http://localhost:8668"
+IOTA_URL=http://localhost:4041
+QL_URL=http://localhost:8668
 
 # CSRF
 CSRF_TRUSTED_ORIGINS=[]

app/Entirety/devices/templates/devices/list.html

@@ -12,14 +12,14 @@
             <a class="nav-link" data-bs-toggle="tab" href="#devices">Devices</a>
         </li>
         <li class="nav-item">
-            <a class="nav-link active" data-bs-toggle="tab" href="#groups">Services Group</a>
+            <a class="nav-link active" data-bs-toggle="tab" href="#groups">Service Groups</a>
         </li>
     {% else %}
         <li class="nav-item">
             <a class="nav-link active" data-bs-toggle="tab" href="#devices">Devices</a>
         </li>
         <li class="nav-item">
-            <a class="nav-link" data-bs-toggle="tab" href="#groups">Services Group</a>
+            <a class="nav-link" data-bs-toggle="tab" href="#groups">Service Groups</a>
         </li>
     {% endif %}
 </ul>
@@ -159,7 +159,7 @@ <h5 class="modal-title" id="deleteModalAdvLabel">Delete Device</h5>
   {% else %}
   <div class="tab-pane container fade" id="groups">
   {% endif %}
-    <h3>Services Group</h3>
+    <h3>Service Groups</h3>
     <form action="" method="GET">
         {% csrf_token %}
         <div class="row justify-content-center">

app/Entirety/entirety/context_processors.py

@@ -0,0 +1,5 @@
+from django.conf import settings
+
+
+def logo_filename(request):
+    return {"logo_filename": settings.LOGO_FILENAME}

app/Entirety/entirety/settings.py

@@ -157,6 +157,7 @@ class Settings(BaseSettings):
                     "django.template.context_processors.request",
                     "django.contrib.auth.context_processors.auth",
                     "django.contrib.messages.context_processors.messages",
+                    "entirety.context_processors.logo_filename",
                 ],
             },
         },
@@ -318,7 +319,7 @@ def secret_key_not_empty(cls, v) -> str:
     IOTA_URL: AnyUrl = Field(default="http://localhost:4041", alias="IOTA_URL")
 
     # CSRF
-    CSRF_TRUSTED_ORIGINS: list = Field(default=[], alias="CSRF_TRUSTED_ORIGINS ")
+    CSRF_TRUSTED_ORIGINS: list = Field(default=[], alias="CSRF_TRUSTED_ORIGINS")
 
     # Database
     # https://docs.djangoproject.com/en/4.0/ref/settings/#databases
@@ -377,6 +378,8 @@ def secret_key_not_empty(cls, v) -> str:
         OIDC_TOKEN_ROLE_PATH: str = Field(
             default="$.entirety.roles", alias="OIDC_TOKEN_ROLE_PATH"
         )
+    else:
+        LOCAL_AUTH_SIGNUP: bool = Field(default=False, alias="LOCAL_AUTH_SIGNUP")
 
     # Internationalization
     # https://docs.djangoproject.com/en/4.0/topics/i18n/
@@ -390,6 +393,8 @@ def secret_key_not_empty(cls, v) -> str:
         default=os.path.join(BASE_DIR, "media/"), alias="MEDIA_ROOT"
     )
 
+    LOGO_FILENAME: str = Field(default="Entirety-logo.png", alias="LOGO_FILENAME")
+
     TIME_ZONE: str = Field(default="Europe/Berlin", alias="TIME_ZONE")
 
     COMPRESS_ENABLED: bool = Field(default=not DEBUG, alias="COMPRESS_ENABLED")

app/Entirety/entities/templates/entities/delete.html

@@ -5,6 +5,7 @@
 {% block content %}
     <form method="post" action="">
         <div>
+            {% csrf_token %}
             {% include 'accordion.html' %}
             <button class="btn btn-danger rounded-pill" type="submit">Delete</button>
         </div>

app/Entirety/entities/templates/entities/entity_list.html

@@ -23,7 +23,7 @@
                         </div>
                         <div class="input-group-append">
                             <button type="submit"
-                                    class="btn btn bi-search rounded-pill bg-primary"
+                                    class="btn btn bi-search rounded-pill bg-primary  ms-2"
                                     data-bs-toggle="tooltip"
                                     title="Start Search"
                                     id="search-button"