Merge pull request #32 from FalkorDB/extras

Move deps to Extras
FalkorDB · Nov 12, 2024 · 9131f2a · 9131f2a
2 parents 52e3042 + 1216d9c
commit 9131f2a
Show file tree

Hide file tree

Showing 8 changed files with 760 additions and 750 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -58,7 +58,7 @@ jobs:
           curl -sSL https://install.python-poetry.org | python3 -
 
       - name: Install dependencies
-        run: poetry install
+        run: poetry install --extras "all"
 
       - name: Wait for Ollama to be ready
         run: |

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -54,7 +54,7 @@ To set up **GraphRAG-SDK** for local development:
 
 2. Install the required dependencies:
    ```bash
-   poetry install
+   poetry install --extras "all"
    ```
 
 ## Pull Request Guidelines

diff --git a/README.md b/README.md
@@ -21,7 +21,13 @@ GraphRAG-SDK is a comprehensive solution for building Graph Retrieval-Augmented
 ### Install
 
 ```sh
-pip install graphrag_sdk
+pip install graphrag_sdk[all]
+```
+
+or (if only OpenAI is required)
+
+```sh
+pip install graphrag_sdk[openai]
 ```
 
 ### Prerequisites

diff --git a/examples/movies/demo-movies.ipynb b/examples/movies/demo-movies.ipynb
@@ -15,7 +15,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install graphrag_sdk"
+    "!pip install graphrag_sdk[openai]"
    ]
   },
   {

diff --git a/examples/trip/demo_orchestrator_trip.ipynb b/examples/trip/demo_orchestrator_trip.ipynb
@@ -15,7 +15,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install graphrag_sdk"
+    "!pip install graphrag_sdk[openai]"
    ]
   },
   {

diff --git a/examples/ufc/demo-ufc.ipynb b/examples/ufc/demo-ufc.ipynb
@@ -15,7 +15,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install graphrag_sdk"
+    "!pip install graphrag_sdk[openai]"
    ]
   },
   {

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -15,16 +15,23 @@ falkordb = "^1.0.9"
 typing-extensions = "^4.12.1"
 bs4 = "^0.0.2"
 pypdf = "^4.2.0"
-vertexai = "^1.49.0"
 backoff = "^2.2.1"
 python-abc = "^0.2.0"
 ratelimit = "^2.2.1"
 python-dotenv = "^1.0.1"
-openai = "^1.35.9"
 fix-busted-json = "^0.0.18"
-ollama = "^0.2.1"
 ipykernel = "^6.29.5"
-google-generativeai = "^0.8.1"
+vertexai = { version = "^1.49.0", optional = true } 
+ollama = { version = "^0.2.1", optional = true }
+openai = { version = "^1.35.9", optional = true }
+google-generativeai = { version = "^0.8.1", optional = true }
+
+[tool.poetry.extras]
+all = ["vertexai", "ollama", "openai", "google-generativeai"]
+ollama = ["ollama"]
+openai = ["openai"]
+vertexai = ["vertexai"]
+google-generativeai = ["google-generativeai"]
 
 [tool.poetry.group.test.dependencies]
 pytest = "^8.2.1"