From 0730db572785e2639a6454c601dca67b08b4a311 Mon Sep 17 00:00:00 2001
From: EndMove <superjeremi1302@gmail.com>
Date: Sat, 7 Oct 2023 15:14:18 +0200
Subject: [PATCH] feat: package manager

---
 .editorconfig          | 14 ++++++++++++++
 .gitignore             |  3 ++-
 README.MD => README.md | 15 +++++++++++----
 main.py                |  3 +--
 requirements.txt       |  9 +++++++++
 5 files changed, 37 insertions(+), 7 deletions(-)
 create mode 100644 .editorconfig
 rename README.MD => README.md (90%)
 create mode 100644 requirements.txt

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..c03a972
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 120
+
+[*.md]
+trim_trailing_whitespace = false
+max_line_length = 0
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 70df3e4..64e03f3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 /transcripts
 /index
-/.idea
\ No newline at end of file
+/.idea
+/venv
diff --git a/README.MD b/README.md
similarity index 90%
rename from README.MD
rename to README.md
index a465238..0efe6b3 100644
--- a/README.MD
+++ b/README.md
@@ -9,9 +9,15 @@ Well, let's ask our LLM:
 
 ## How to run
 ### Install dependencies
-I have no idea what the correct way to install dependencies with python is. Somehow install these libraries and their dependencies:
-- llama_index
-- beautifulsoup4
+It is recommended to use a python version greater than or equal to ``3.10.0``.
+Another stuff recommended, is to create a venv or use an IDE that supports venv creation, so all dependencies are installed locally to the project and not globally. If not, you can use https://virtualenv.pypa.io/en/latest/ to artificially create isolated environments.
+
+Install the dependencies required to run the project by running the following command at the project root :
+
+```shell
+pip install -r requirements.txt
+```
+
 ### Execution
 Download transcripts:
 ```shell
@@ -31,6 +37,7 @@ python3 main.py
 On the first run, it will generate the index. This can take a while, but it will be cached on disk for the next runs.
 
 You can then ask it any questions about Darknet Diaries!
+
 ## Examples
 
 > What is the intro of the podcast?
@@ -69,4 +76,4 @@ You can then ask it any questions about Darknet Diaries!
 >>The episode also covers a project where Jason was tasked with hacking into a large, worldwide bank. His job was to examine the bank's mobile app for any potential security vulnerabilities that could expose customer or sensitive information. The episode provides a detailed look into the world of penetration testing, highlighting the importance of robust security measures in both physical and digital spaces.
 > 
 > How many downloads does this episode have?
->> Episode 130 of Darknet Diaries, titled "JASON'S PEN TEST", has 667,528 downloads.
\ No newline at end of file
+>> Episode 130 of Darknet Diaries, titled "JASON'S PEN TEST", has 667,528 downloads.
diff --git a/main.py b/main.py
index f52238e..b7785ad 100644
--- a/main.py
+++ b/main.py
@@ -4,7 +4,7 @@ from llama_index.node_parser import SimpleNodeParser
 from llama_index import VectorStoreIndex
 from llama_index.llms import OpenAI, ChatMessage, MessageRole
 from llama_index.prompts import ChatPromptTemplate
-from llama_index import set_global_handler
+# from llama_index import set_global_handler
 from llama_index.chat_engine.types import ChatMode
 import os
 import re
@@ -103,4 +103,3 @@ while True:
         chat_engine.chat_repl()
     except KeyboardInterrupt:
         break
-
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..2c96fbe
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,9 @@
+# =====================
+# Required dependencies
+# =====================
+llama-index==0.8.*
+beautifulsoup4==4.12.*
+
+# =====================
+# Development dependencies
+# =====================