feat: package manager

This commit is contained in:
Jérémi N ‘EndMove’ 2023-10-07 15:14:18 +02:00
parent fbcf0168f9
commit 0730db5727
Signed by untrusted user: EndMove
GPG Key ID: 65C4A02E1F5371A4
5 changed files with 37 additions and 7 deletions

14
.editorconfig Normal file
View File

@ -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

1
.gitignore vendored
View File

@ -1,3 +1,4 @@
/transcripts
/index
/.idea
/venv

View File

@ -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?

View File

@ -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

9
requirements.txt Normal file
View File

@ -0,0 +1,9 @@
# =====================
# Required dependencies
# =====================
llama-index==0.8.*
beautifulsoup4==4.12.*
# =====================
# Development dependencies
# =====================