chore: switch to uv packaging (#10)

Author: micpst

.github/workflows/ci.yml

@@ -16,7 +16,14 @@ jobs:
       contents: read
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          version: "0.4.10"
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
@@ -26,11 +33,13 @@ jobs:
           path: ~/.cache/pre-commit
           key: pre-commit-3|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
 
-      - name: Install pre-commit
-        run: pip3 install pre-commit
+      - name: Install Dependencies
+        run: source ./setup_dev_env.sh
 
       - name: Run pre-commit checks
-        run: pre-commit run --all-files --show-diff-on-failure --color always
+        run: |
+          source .venv/bin/activate
+          pre-commit run --all-files --show-diff-on-failure --color always
 
       - name: Run Trivy vulnerability scanner
         uses: aquasecurity/trivy-action@master
@@ -57,17 +66,14 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           comment_tag: trivy
 
-      - name: Create venv
-        run: . ./setup_dev_env.sh
-
       - name: Check licenses
         run: |
-          source venv/bin/activate
+          source .venv/bin/activate
           ./check_licenses.sh
 
       - name: Generate pip freeze
         run: |
-          source venv/bin/activate
+          source .venv/bin/activate
           pip freeze > requirements-freeze.txt
 
       - name: Publish Artefacts
@@ -93,9 +99,8 @@ jobs:
 
       - name: Validate package build
         run: |
-          source venv/bin/activate
-          python -m pip install -U build
-          for dir in packages/*/; do python -m build "$dir"; done
+          source .venv/bin/activate
+          for dir in packages/*/; do uv build "$dir" --out-dir dist; done
 
       - name: Publish Package
         uses: actions/upload-artifact@v3
@@ -121,6 +126,12 @@ jobs:
           - python-version: "3.10"
     steps:
       - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          version: "0.4.10"
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
@@ -129,18 +140,18 @@ jobs:
       - name: Cache Dependencies
         uses: actions/cache@v3
         with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-dev.txt') }}-${{ hashFiles('**/setup.cfg') }}-${{ hashFiles('**/pyproject.toml') }}
+          path: ~/.cache/uv
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
       - name: Install Dependencies
-        run: . ./setup_dev_env.sh
+        run: source ./setup_dev_env.sh
 
       - name: Run Tests With Coverage
         run: |
           # run with coverage to not execute tests twice
-          source venv/bin/activate
+          source .venv/bin/activate
           coverage run -m pytest -v -p no:warnings --junitxml=report.xml
           coverage report
           coverage xml

README.md

@@ -1,22 +1,19 @@
-# ragbits
+# Ragbits
 
 Repository for internal experiment with our upcoming LLM framework.
 
+# Installation
 
-# Setup developer environment
+## Build from source
 
-To start, you need to setup your local machine.
+To build and run Ragbits from the source code:
 
-## Setup venv
-
-You need to setup virtual environment, simplest way is to run from project root directory:
+1. Requirements: [**uv**](https://docs.astral.sh/uv/getting-started/installation/) & [**python**](https://docs.astral.sh/uv/guides/install-python/) 3.10 or higher
+2. Install dependencies and run venv in editable mode:
 
 ```bash
-$ . ./setup_dev_env.sh
-$ source venv/bin/activate
+$ source ./setup_dev_env.sh
 ```
-This will create a new venv and install all packages from this repository in editable mode.
-It will also intall their dependencies and the dev dependencies from `requirements-dev.txt`.
 
 ## Install pre-commit
 

check_licenses.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 set -e
 
-. venv/bin/activate
+source .venv/bin/activate
 
-pip-licenses --from=mixed  --ignore-packages `cat .libraries-whitelist.txt`> licenses.txt
+uv run pip-licenses --from=mixed  --ignore-packages `cat .libraries-whitelist.txt`> licenses.txt
 cat licenses.txt
 
 FOUND=$(tail -n +2 licenses.txt | grep -v -f .license-whitelist.txt | wc -l)

docker/precommit/Dockerfile

@@ -0,0 +1 @@
+# Ragbits Core

packages/ragbits-common/pyproject.toml

@@ -1,9 +1,15 @@
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#     "ragbits[litellm]",
+# ]
+# ///
 import asyncio
 
 from pydantic import BaseModel
 
-from ragbits.common.llms.litellm import LiteLLM
-from ragbits.common.prompt import Prompt
+from ragbits.core.llms.litellm import LiteLLM
+from ragbits.core.prompt import Prompt
 
 
 class LoremPromptInput(BaseModel):

packages/ragbits-common/setup.cfg

@@ -1,6 +1,12 @@
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#     "ragbits",
+# ]
+# ///
 from pydantic import BaseModel
 
-from ragbits.common.prompt import Prompt
+from ragbits.core.prompt import Prompt
 
 
 class LoremPromptInput(BaseModel):

packages/ragbits-common/src/ragbits/common/prompt/__init__.py

@@ -0,0 +1,69 @@
+[project]
+name = "ragbits"
+version = "0.1.0"
+description = "Building blocks for rapid development of GenAI applications"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "deepsense.ai", email = "contact@deepsense.ai"}
+]
+keywords = [
+    "Retrieval Augmented Generation",
+    "RAG",
+    "Large Language Models",
+    "LLMs",
+    "Generative AI",
+    "GenAI",
+    "Prompt Management"
+]
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "Environment :: Console",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Private :: Do Not Upload"
+]
+dependencies = [
+    "jinja2>=3.1.4",
+    "pydantic>=2.9.1"
+]
+
+[project.optional-dependencies]
+litellm = [
+    "litellm~=1.46.0",
+]
+local = [
+    "torch~=2.2.1",
+    "transformers~=4.44.2",
+    "numpy~=1.24.0"
+]
+
+[tool.uv]
+dev-dependencies = [
+    "pre-commit~=3.8.0",
+    "pytest~=8.3.3",
+    "pytest-cov~=5.0.0",
+    "pytest-asyncio~=0.24.0",
+    "pip-licenses>=4.0.0,<5.0.0"
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ragbits"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

packages/ragbits-core/README.md

@@ -7,8 +7,8 @@
 except ImportError:
     HAS_LITELLM = False
 
-from ragbits.common.embeddings.base import Embeddings
-from ragbits.common.embeddings.exceptions import EmbeddingConnectionError, EmbeddingResponseError, EmbeddingStatusError
+from ragbits.core.embeddings.base import Embeddings
+from ragbits.core.embeddings.exceptions import EmbeddingConnectionError, EmbeddingResponseError, EmbeddingStatusError
 
 
 class LiteLLMEmbeddings(Embeddings):

packages/ragbits-common/examples/llm_example.py renamed to packages/ragbits-core/examples/llm_example.py

@@ -2,7 +2,7 @@
 from functools import cached_property
 from typing import Generic, Optional, Type, cast, overload
 
-from ragbits.common.prompt.base import BasePrompt, BasePromptWithParser, OutputT
+from ragbits.core.prompt.base import BasePrompt, BasePromptWithParser, OutputT
 
 from .clients.base import LLMClient, LLMClientOptions, LLMOptions
 

packages/ragbits-common/examples/prompt_example.py renamed to packages/ragbits-core/examples/prompt_example.py

@@ -4,7 +4,7 @@
 
 from pydantic import BaseModel
 
-from ragbits.common.prompt import ChatFormat
+from ragbits.core.prompt import ChatFormat
 
 from ..types import NotGiven
 

packages/ragbits-core/pyproject.toml

@@ -11,7 +11,7 @@
     HAS_LITELLM = False
 
 
-from ragbits.common.prompt import ChatFormat
+from ragbits.core.prompt import ChatFormat
 
 from ..types import NOT_GIVEN, NotGiven
 from .base import LLMClient, LLMOptions

packages/ragbits-common/src/py.typed renamed to packages/ragbits-core/src/py.typed

@@ -11,7 +11,7 @@
 except ImportError:
     HAS_LOCAL_LLM = False
 
-from ragbits.common.prompt import ChatFormat
+from ragbits.core.prompt import ChatFormat
 
 from ..types import NOT_GIVEN, NotGiven
 from .base import LLMClient, LLMOptions

packages/ragbits-common/examples/__init__.py renamed to packages/ragbits-core/src/ragbits/core/__init__.py

@@ -8,7 +8,7 @@
 except ImportError:
     HAS_LITELLM = False
 
-from ragbits.common.prompt.base import BasePrompt
+from ragbits.core.prompt.base import BasePrompt
 
 from .base import LLM
 from .clients.litellm import LiteLLMClient, LiteLLMOptions

packages/ragbits-common/src/ragbits/common/__init__.py renamed to packages/ragbits-core/src/ragbits/core/embeddings/__init__.py

@@ -8,7 +8,7 @@
 except ImportError:
     HAS_LOCAL_LLM = False
 
-from ragbits.common.prompt.base import BasePrompt
+from ragbits.core.prompt.base import BasePrompt
 
 from .base import LLM
 from .clients.local import LocalLLMClient, LocalLLMOptions