Merge branch 'main' into 0.4.0-fix

Signed-off-by: Zachary BENSALEM <[email protected]>

.github/workflows/python-publish.yml

@@ -5,35 +5,60 @@
 # They are provided by a third-party and are governed by
 # separate terms of service, privacy policy, and support
 # documentation.
+
 
-name: Upload Python Package
-
+name: Python Publish
 on:
   release:
-    types: [published]
+    types: [created]
+  push:
+    branches: [main]
 
-permissions:
-  contents: read
+env:
+  POETRY_VERSION: "1.8.3"
+  PYTHON_VERSION: "3.10"
 
 jobs:
-  deploy:
-
+  publish:
+    name: Upload release to PyPI
+    if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/graphfleet
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@ec4db0b4ddc65acdf4bff5fa45ac92d78b56bdf0
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install Poetry
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: ${{ env.POETRY_VERSION }}
+
+      - name: Install dependencies
+        shell: bash
+        run: poetry install
+
+      - name: Export Publication Version
+        run: echo "version=`poetry version --short`" >> $GITHUB_OUTPUT
+
+      - name: Build Distributable
+        shell: bash
+        run: poetry build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+          skip-existing: true
+          verbose: true

README.md

@@ -10,8 +10,7 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question
 <<<<<<< HEAD
 
 ## Roadmap
-=======
->>>>>>> origin/main
+
 
 - [ ] Provide a FleetUI Design Kit and a quicker way of starting GraphFleet locally.
 - [ ] Provide a Toddle interface ready to use for GraphFleet
@@ -33,7 +32,7 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question
 
 - Leave us a star ♥
 - Fork and contribute to the project
-- [![Join the discord](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date)
+- [![Join the discord](https://discord.gg/BD8MPgzEJc)
 
 ## Getting Started
 
@@ -51,29 +50,27 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question
 ### Installation
 
 1. Clone the repository:
-<<<<<<< HEAD
-=======
 
 ``` bash
    git clone https://github.com/Qredence/GraphFleet.git
    cd GraphFleet
 ```
->>>>>>> origin/main
+
 
    ``` bash
    git clone https://github.com/Qredence/GraphFleet.git
    cd GraphFleet
    ```
 
-<<<<<<< HEAD
+
 2. Simply run these in your terminal:
 
    ``` bash
    poetry shell
    poetry install
    ```
 
-=======
+
 2. Create a virtual environment and activate it:
 
 ``` bash
@@ -86,13 +83,13 @@ source gfleetenv/bin/activate
 ```
 pip install -r requirements.txt
 ```
->>>>>>> origin/main
+
 
 ### Usage
 
 1. Configuration:
 Environment Variables: Set up your environment variables in a .env file (refer to the .env.example file for available options). Key variables include:
-<<<<<<< HEAD
+
 
    ```sh
    export GRAPHRAG_API_KEY="<apikey>"
@@ -125,7 +122,7 @@ streamlit run app.py
 
 Access the interface in your web browser at the provided URL (usually <http://localhost:8080>).
 
-=======
+
 
 ```
 GRAPHRAG_API_KEY
@@ -154,7 +151,7 @@ streamlit run app.py
 ```
 Access the interface in your web browser at the provided URL (usually http://localhost:8080).
 
->>>>>>> origin/main
+
 ``` bash
 python -m graphrag.query --root ./graphfleet --method local "What are the key features of GraphRAG ??"
 ```
@@ -164,10 +161,8 @@ For Global query mode :
 ``` bash
 python -m graphrag.query --root ./graphfleet --method global "What are the top main features of GraphRAG"
 ```
-<<<<<<< HEAD
 
-=======
->>>>>>> origin/main
+
 ### Running the API only
 
 To run the API, save the code in a file named api.py and execute the following command in your terminal:
@@ -186,8 +181,5 @@ uvicorn api:app --reload --port 8001
 
 ## Star History
 
-<<<<<<< HEAD
 [![Star History Chart](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date)
-=======
-[![Star History Chart](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date)
->>>>>>> origin/main
+

graphfleet/api/openapi.yml

@@ -152,4 +152,4 @@ components:
           title: 'Message'
         type:
           type: 'string'
-          title: 'Error Type'
+          title: 'Error Type'