Skip to content

Commit 75ce0d0

Browse files
authored
Update README.md
1 parent c8bda67 commit 75ce0d0

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@ Regulatory assessment tool, developed with python. It utilises a unified knowled
33

44
NIS2 Regulatory Assessment Tool: Development Documentation
55

6-
Introduction
7-
Overview of the Regulatory Assessment Tool
6+
Overview of the Regulatory Assessment Tool:
87
The Regulatory Assessment Tool is designed to measure compliance with NIS2 Cybersecurity risk-management measures (Article 21). The tool utilises a unified knowledge model (ontology stored in GraphDB) to dynamically call multiple choice questions (MCQs) and assess compliance with the NIS2 directive.
98

10-
Purpose and Scope
9+
Purpose and Scope:
1110
The purpose of this tool is to provide organisations with a means to conduct a comprehensive NIS2 gap analysis against the ISO 27001:2022 framework. It maps specific ISO 27001:2022 controls and the essential security controls outlined by ENISA against the ten NIS2 Cybersecurity risk-management measures as detailed in Article 21.
1211

13-
Installation
12+
Installation:
1413
System Requirements
1514
• Python 3.7 or higher
1615
• Flask
@@ -21,7 +20,7 @@ System Requirements
2120
• Flask-Session
2221
• A running instance of GraphDB
2322

24-
Installation Steps
23+
Installation Steps:
2524
1. Clone the repository:
2625
git clone <repository-url>
2726
cd <repository-directory>
@@ -34,7 +33,7 @@ Installation Steps
3433
3. Install the required packages:
3534
pip install -r requirements.txt
3635

37-
Configuration
36+
Configuration:
3837
Setting up the SPARQL Endpoint
3938
Ensure that the GraphDB instance is running and accessible. Update the SPARQL endpoint URL in the `RegulatoryAssessmentTool` class within `main.py`:
4039
self.sparql = SPARQLWrapper("http://localhost:8080/repositories/NIS2Ontology")
@@ -46,28 +45,28 @@ app = Flask(__name__, static_url_path='/static')
4645
app.secret_key = secret_key
4746

4847

49-
Usage
48+
Usage:
5049
Starting the Application
5150
Run the Flask application:
5251
flask run
5352
Access the application in the web browser at `http://127.0.0.1:5000`.
5453

55-
Navigating the Welcome Page
54+
Navigating the Welcome Page:
5655
The welcome page introduces the tool and provides an overview of NIS2 requirements. Click "Begin Assessment" to start the compliance assessment.
5756

58-
Conducting an Assessment
57+
Conducting an Assessment:
5958
Answer the multiple-choice questions presented. Each question is dynamically fetched from the ontology.
6059

61-
Viewing Results
60+
Viewing Results:
6261
After completing the assessment, view detailed results categorized by implementation status and article. Recommendations are provided for partial or non-implemented measures.
6362

64-
Generating Reports
63+
Generating Reports:
6564
Click "Download Report" on the results page to generate a PDF report of the assessment, including scores, compliance percentage, and recommendations.
6665

67-
User Feedback
66+
User Feedback:
6867
Users can provide feedback through a feedback form available after the assessment. The feedback form includes questions on usability, content relevance, and overall satisfaction.
6968

70-
Code Overview
69+
Code Overview:
7170
main.py: Explanation of the Main Application File
7271
Class: RegulatoryAssessmentTool
7372
`__init__`: Initializes the SPARQL endpoint and question label scores.

0 commit comments

Comments
 (0)