Feature/ship config (#88)

* ship with config * increment
SciPhi-AI · Feb 27, 2024 · 7380d0d · 7380d0d
1 parent 9956ac0
commit 7380d0d
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -35,28 +35,28 @@ The project includes several basic examples that demonstrate application deploym
 1. [`app.py`](examples/basic/app.py): This example runs the main application, which includes the ingestion, embedding, and RAG pipelines served via FastAPI.
 
    ```bash
-   poetry run uvicorn r2r.examples.basic.app:app
+   uvicorn r2r.examples.basic.app:app
    ```
 
 2. [`run_client.py`](examples/basic/run_client.py): This example should be run after starting the main application. It demonstrates uploading text entries as well as a PDF to the local server with the python client. Further, it shows document and user-level vector management with built-in features.
 
    ```bash
-   poetry run python -m r2r.examples.basic.run_client
+   python -m r2r.examples.basic.run_client
    ```
 
 3. [`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): An example demonstrating upload and chat with a more realistic pdf.
 
    ```bash
    # Ingest pdf
-   poetry run python -m r2r.examples.pdf_chat.run_demo ingest
+   python -m r2r.examples.pdf_chat.run_demo ingest
 
    # Ask a question
-   poetry run python -m r2r.examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
+   python -m r2r.examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
    ```
 
 4. [`web`](web/package.json): A web application which is meant to accompany the framework to provide visual intelligence.
    ```bash
-   cd web && pnpm install
+   cd $workdir/web && pnpm install
    # Serve the web app
    pnpm dev
    ```
@@ -90,6 +90,11 @@ Follow these steps to ensure a smooth setup:
      # use "all" to include every optional dependency
      poetry install --extras "parsing"
      ```
+   - Execute with poetry run:
+     ```bash
+     poetry run python -m r2r.examples.pdf_chat.run_demo ingest
+     ```
+
 
 3. **Configure Environment Variables:**
    - You need to set up cloud provider secrets in your `.env`. At a minimum, you will need an OpenAI key.

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,11 +4,12 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "r2r"
-version = "0.1.2"
+version = "0.1.21"
 description = "SciPhi R2R"
 authors = ["Owen Colegrove <[email protected]>"]
 license = "MIT"
 readme = "README.md"
+include = ["config.json"]
 
 [tool.poetry.dependencies]
 # Python Versions

diff --git a/r2r/examples/academy/__init__.py b/r2r/examples/academy/__init__.py
diff --git a/r2r/examples/pdf_chat/__init__.py b/r2r/examples/pdf_chat/__init__.py
diff --git a/r2r/examples/web_search/__init__.py b/r2r/examples/web_search/__init__.py