Merge branch 'main' into routes

Author: gkorland

.env

@@ -3,6 +3,6 @@ FALKORDB_PORT=<port>
 FALKORDB_USERNAME=<username>
 FALKORDB_PASSWORD=<password>
 OPENAI_API_KEY=<openai_api_key>
-GOOGLE_API_KEY=<google_api_key>
+GEMINI_API_KEY=<gemini_api_key>
 SECRET_TOKEN=<secret_token>
 

.env.template

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    target-branch: "staging"      

.github/dependabot.yml

@@ -0,0 +1,40 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        # flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        
+    # - name: Test with pytest
+    #  run: |
+    #    pytest

.github/workflows/python-app.yml

@@ -0,0 +1,37 @@
+name: Release image to DockerHub
+
+on:
+  workflow_dispatch:
+  push:
+    tags: ["v*.*.*"]
+    branches:
+      - main
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set tags
+        run: |
+          if ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags') }}; then
+            echo "TAGS=falkordb/code-graph-backend:latest,falkordb/code-graph-backend:${{ github.ref_name }}" >> $GITHUB_ENV
+          else
+            echo "TAGS=falkordb/code-graph-backend:edge" >> $GITHUB_ENV
+          fi
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+  
+      - name: Build image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ env.TAGS }}

.github/workflows/release-image.yml

@@ -1,2 +1,44 @@
+# Byte-compiled files
+*.pyc
+*.pyo
+*.pyd
+__pycache__/
+
+# Virtual environments
+venv/
+env/
+.virtualenv/
+
+# Distribution/build files
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# IDE settings
+.vscode/
+.idea/
+*.swp
+
+# Logs and debugging
+*.log
+*.trace
+
+# OS-specific files
+.DS_Store
+Thumbs.db
+
+# Testing and coverage
+htmlcov/
+*.cover
+.coverage
+.cache/
+pytest_cache/
+
+# Jupyter Notebook checkpoints
+.ipynb_checkpoints/
+
+# Custom settings
 .env
+*.sqlite3
 .vercel

.gitignore

@@ -0,0 +1,20 @@
+# Use a Python base image
+FROM python:3.12
+
+# Set working directory
+WORKDIR /api
+
+# Copy requirements.txt and install dependencies
+COPY requirements.txt ./
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy the rest of the application code
+COPY . .
+
+# Expose the port the backend runs on
+EXPOSE 5000
+
+# Start the backend
+#CMD ["python", "index.py"]
+CMD ["flask", "--app", "api/index.py", "run", "--debug"]
+

Dockerfile

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 FalkorDB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -1,21 +1,59 @@
+[![Try Free](https://img.shields.io/badge/Try%20Free-FalkorDB%20Cloud-FF8101?labelColor=FDE900&link=https://app.falkordb.cloud)](https://app.falkordb.cloud)
+[![Dockerhub](https://img.shields.io/docker/pulls/falkordb/falkordb?label=Docker)](https://hub.docker.com/r/falkordb/falkordb/)
+[![Discord](https://img.shields.io/discord/1146782921294884966?style=flat-square)](https://discord.com/invite/6M4QwDXn2w)
+
+## Getting Started
+
+[Live Demo](https://code-graph.falkordb.com/)
+
+## Running locally
+
+### Run FalkorDB
+
+Free cloud instance: https://app.falkordb.cloud/signup
+
+Or by running locally with docker:
+
 ```bash
-flask --app code_graph run --debug
+docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest
 ```
 
-Process local git repository, ignoring specific folder(s)
+### Config
 
+Create your own `.env` file from the `.env.template` file
+
+Start the server:
 ```bash
-curl -X POST http://127.0.0.1:5000/process_local_repo -H "Content-Type: application/json" -d '{"repo": "/Users/roilipman/Dev/FalkorDB", "ignore": ["./.github", "./sbin", "./.git","./deps", "./bin", "./build"]}'
+flask --app api/index.py run --debug
 ```
 
-Process code coverage
+### Creating a graph
+
+Process a local source folder:
 
 ```bash
-curl -X POST http://127.0.0.1:5000/process_code_coverage -H "Content-Type: application/json" -d '{"lcov": "/Users/roilipman/Dev/code_graph/code_graph/code_coverage/lcov/falkordb.lcov", "repo": "FalkorDB"}'
+curl -X POST http://127.0.0.1:5000/analyze_folder -H "Content-Type: application/json" -d '{"path": "<FULL_PATH_TO_FOLDER>", "ignore": [<OPTIONAL_IGNORE_LIST>]}' -H "Authorization: <.ENV_SECRET_TOKEN>"
 ```
 
-Process git information
+For example:
 
 ```bash
-curl -X POST http://127.0.0.1:5000/process_git_history -H "Content-Type: application/json" -d '{"repo": "/Users/roilipman/Dev/falkorDB"}'
+curl -X POST http://127.0.0.1:5000/analyze_folder -H "Content-Type: application/json" -d '{"path": "/Users/roilipman/Dev/GraphRAG-SDK", "ignore": ["./.github", "./build"]}' -H "Authorization: OpenSesame"
 ```
+
+## Working with your graph
+
+Once the source code analysis completes your FalkorDB DB will be populated with
+a graph representation of your source code, the graph name should be the same as
+the name of the folder you've requested to analyze, for the example above a graph named:
+"GraphRAG-SDK".
+
+At the moment only the Python and C languages are supported, we do intend to support additional languages.
+
+At this point you can explore and query your source code using various tools
+Here are several options:
+
+1. [Code-Graph UI](https://github.com/FalkorDB/code-graph)
+1. FalkorDB [Browser](https://github.com/FalkorDB/falkordb-browser/)
+2. One of FalkorDB's [clients](https://docs.falkordb.com/clients.html)
+3. Use FalkorDB [GraphRAG-SDK](https://github.com/FalkorDB/GraphRAG-SDK) to connect an LLM for natural language exploration.

README.md

@@ -1,7 +1,9 @@
 from .info import *
 from .llm import ask
 from .graph import *
+from .project import *
 from .entities import *
+from .git_utils import *
 from .code_coverage import *
 from .analyzers.source_analyzer import *
 from .auto_complete import prefix_search