Added custom base URL

Author: frederickmannings

.env.example

@@ -0,0 +1,2 @@
+DYNARAG_API_TOKEN=<your_jwt_token>
+DYNARAG_BASE_URL=<your_base_url>

README.md

@@ -1,15 +1,23 @@
 # DynaRAG
 
-This is the Python client to the [DynaRAG API](https://www.dynarag.com).
+This is the Python client to [DynaRAG](https://github.com/Predixus/DynaRAG).
 
-DynaRAG provides a simple and fast interface to implement RAG (Retrieval Augemented Generation) into your application.
+DynaRAG provides a simple and fast interface to implement RAG (Retrieval Augemented Generation)
+into your application.
 
 ## Configuration
 
-DynaRAG only requires an API token to get started. You can obtain an API token by going to the [DynaRAG App](https://app.dynarag.com),
+DynaRAG requires some environment variables to get started:
+- `DYNARAG_API_TOKEN` - a signed JWT that contains data needed by DynaRAG. Follow the spec in the [DynaRAG](https://github.com/Predixus/DynaRAG)
+service repo.
+- `DYNARAG_BASE_URL` - url to the DynaRAG service. e.g. http://localhost:7890
+
+You can obtain an API token by going to the [DynaRAG App](https://app.dynarag.com),
 logging in and navigating to dashboard>developer. From here you can generate an API token.
 
-> :warning: **API Token**: Put your API token into an environment varibale called `DYNARAG_API_TOKEN` in order for the DynaRAG Client to discover it.
+> :warning: **API Token**: Put your API token into an environment variable called `DYNARAG_API_TOKEN`
+> in order for the DynaRAG Client to discover it. This must be a JWT that follows the spec of the
+> [DynaRAG service](https://github.com/Predixus/DynaRAG).
 
 ## Usage
 

dynarag/constants.py

@@ -8,3 +8,7 @@ class MissingAPIToken(BaseException):
 
 class BadAPIRequest(BaseException):
     """Raised if a request to the DynaRAG API fails"""
+
+
+class BadEnvironment(BaseException):
+    """Raised when the environment is bad"""

dynarag/exceptions.py

@@ -5,14 +5,12 @@
 import urllib.request
 from typing import Any, Dict, List, TypeVar, Optional, TypedDict, cast
 
-from dynarag.constants import DYNARAG_BASE_URL
-from dynarag.exceptions import BadAPIRequest, MissingAPIToken
+from dynarag.exceptions import BadAPIRequest, MissingAPIToken, BadEnvironment
 
 LOGGER = logging.getLogger(__name__)
 
 T = TypeVar("T")
 
-
 class Similar(TypedDict):
     ID: int
     DocumentID: int
@@ -51,17 +49,26 @@ class DynaRAGClient:
     def __init__(self) -> None:
         """Initialise the DynaRAG client."""
         api_token = os.environ.get("DYNARAG_API_TOKEN", None)
+        base_url = os.environ.get("DYNARAG_BASE_URL", None)
         if not api_token:
             error_str = (
-                "Could not find the `DYNARAG_API_TOKEN` environment variable."
-                "You can obtain one by going to https://app.dynarag.com/dashboard/developer and generate a token."
+                "Could not find the `DYNARAG_API_TOKEN` environment variable. "
             )
             LOGGER.error(error_str)
             raise MissingAPIToken(error_str)
+        if not base_url:
+            error_str = (
+                "Could not find the `DYNARAG_BASE_URL` environment variable. "
+                "Set it to the URL of your DynaRAG service, e.g. http://localhost:7890. "
+                "Follow the instructions in the DynaRAG service repo to get started: "
+                "https://github.com/predixus/dynarag?tab=readme-ov-file#getting-started"
+            )
+            LOGGER.error(error_str)
+            raise BadEnvironment(error_str)
 
-        LOGGER.info("Obtained DynaRAG API key. Successfully initialised.")
+        LOGGER.info("Obtained DynaRAG API key and service URL. Successfully initialised.")
 
-        self.base_url = DYNARAG_BASE_URL
+        self.base_url = base_url
         self.api_token = api_token
 
     def _make_request(