Merge pull request #118 from glenda1015/glenda1015/updated-docs

Updated documentation of the triage portal

README.md

@@ -18,8 +18,8 @@ button. A new widow will open. This is needed because VS Code launch settings ar
 within the omega/triage-portal folder.
 
 You can then run the Django launch task to start the application. Navigate to
-<http://localhost:0/admin> and enter the default credentials (admin/admin), then
-navigate back to <http://localhost:8001>.
+<http://localhost:8001/admin/login/?next=/admin/> and enter the default credentials that you created (admin/admin),
+then navigate back to <http://localhost:8001>.
 
 ## Local Development
 
@@ -55,7 +55,16 @@ Issues enabling python virtualenv
 
 https://stackoverflow.com/questions/69605313/vs-code-terminal-activate-ps1-cannot-be-loaded-because-running-scripts-is-disa
 
-### Azure Development Environment
+
+## The API Connecting The Omega Analyser And Triage Portal
+
+The documentation for the API that connects the Omega Analyzer and Triage Portal is housed within the GraphiQL IDE, which is basically a playground
+offered by GraphQL to facilitate interactions with its APIs. It is conveniently accessible through the `http://localhost:8001/graphql` endpoint.
+This documentation becomes available after the application is successfully deployed.
+
+**_File Size:_** Please be aware that the current file size limitation for the API stands at `200 MB`. This constraint should be considered when handling file uploads or other data interactions within the Triage Portal's API.
+
+## Azure Development Environment
 
 The Proof of concept webapp is available at https://otpdev1.eastus.cloudapp.azure.com/admin
 

src/triage/docs/mapping-of-database.md

@@ -0,0 +1,48 @@
+# Visualizing The Database of Omega Triage Portal
+This document provides instructions on how to create a visualization of the database for the Triage Portal.
+
+## Instructions
+Make sure you have the following packages installed or specified in your project's `requirements.txt`.
+- django-extensions
+  - https://pypi.org/project/django-extensions/
+- pydot
+  - https://pypi.org/project/pydot/
+
+### Default Settings
+In your Django project's `setting.py` file, add the following configurations:
+```bash
+INSTALLED_APPS = (
+    # ...
+    'django_extensions',
+    # ...
+)
+
+GRAPH_MODELS = {
+  'all_applications': True,
+  'group_models': True,
+}
+```
+
+### Docker Setup
+If you are using Docker, add graphviz to your `Dockerfile` to install necessary packages and set up the environment:
+```bash
+RUN apt-get update && apt-get install -y --no-install-recommends \
+                        # ...
+                        graphviz \
+                        # ...
+                        && apt-get clean && rm -rf /var/lib/apt/lists/*
+```
+
+### Obtaining The Graph
+Have the containers running and inside the Docker container for your Triage Portal application named `omega-triage-portal`,
+execute the following command to generate the database visualization as a PNG image.
+In this case, this will generate a PNG file named myapp_models.png.
+
+```bash
+python manage.py graph_models -a -o myapp_models.png
+```
+
+After the command is successfully executed, to access the generated image, you can download it from inside the Docker container.
+
+### Helpful link
+Documentation link: https://django-extensions.readthedocs.io/en/latest/graph_models.html

src/triage/models/filter.py

@@ -94,7 +94,8 @@ def get_filter_function(cls, function_body: str, the_type: str) -> Any | None:
             if Filter.is_safe_function(function_str):
                 return compile(function_str, the_type, "exec")
             raise Exception("Function is not safe.")
-        except Exception as msg:  # pylint: disable=broad-except
+        # pylint: disable=broad-except
+        except Exception as msg:
             logger.warning("Invalid %s function: %s", the_type, msg)
             return None