From 49e0b8423f653ae4095e124d3cca50f3d9eade73 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 25 Nov 2025 13:13:37 -0800 Subject: [PATCH] python requirement, readme links --- README.md | 42 +++++++++++++++------------- docs/docs/get-started/docker.mdx | 2 +- docs/docs/get-started/install.mdx | 2 +- docs/docs/get-started/quickstart.mdx | 2 +- 4 files changed, 25 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index d7d1b614..4e861740 100644 --- a/README.md +++ b/README.md @@ -18,27 +18,29 @@ OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables
Quickstart   |   - TUI Interface   |   - Docker Deployment   |   + Python package   |   + Docker or Podman   |   Development   |   Troubleshooting
## Quickstart -To quickly run OpenRAG without creating or modifying any project files, use `uvx`: +To run OpenRAG without creating or modifying any project files, use `uvx`: ```bash uvx openrag ``` -This runs OpenRAG without installing it to your project or globally. -To run a specific version of OpenRAG, add the version to the command, such as: `uvx --from openrag==0.1.25 openrag`. + +This command runs OpenRAG without installing it to your project or globally. + +To run a specific version of OpenRAG, run `uvx --from openrag==VERSION openrag`. ## Install Python package -To first set up a project and then install the OpenRAG Python package, do the following: +To add the OpenRAG Python package to a Python project, use `uv`: -1. Create a new project with a virtual environment using `uv init`. +1. Create a new project with a virtual environment using `uv init`: ```bash uv init YOUR_PROJECT_NAME @@ -48,33 +50,33 @@ To first set up a project and then install the OpenRAG Python package, do the fo The `(venv)` prompt doesn't change, but `uv` commands will automatically use the project's virtual environment. For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments). -2. Add OpenRAG to your project. +2. Add OpenRAG to your project: + ```bash uv add openrag ``` - To add a specific version of OpenRAG: - ```bash - uv add openrag==0.1.25 - ``` + To add a specific version of OpenRAG, run `uv add openrag==VERSION`. + +3. Start the OpenRAG terminal user interface (TUI): -3. Start the OpenRAG TUI. ```bash uv run openrag ``` 4. Continue with the [Quickstart](https://docs.openr.ag/quickstart). -For the full TUI installation guide, see [TUI](https://docs.openr.ag/install). +For all installation options, see the [OpenRAG installation guide](https://docs.openr.ag/install). ## Docker or Podman installation -For more information, see [Install OpenRAG containers](https://docs.openr.ag/docker). - -## Troubleshooting - -For common issues and fixes, see [Troubleshoot](https://docs.openr.ag/support/troubleshoot). +By default, OpenRAG automatically starts the required containers and helps you manage them. +To install OpenRAG with self-managed containers, see the [OpenRAG installation guide](https://docs.openr.ag/docker). ## Development -For developers wanting to contribute to OpenRAG or set up a development environment, see [CONTRIBUTING.md](CONTRIBUTING.md). \ No newline at end of file +For developers wanting to contribute to OpenRAG or set up a development environment, see [CONTRIBUTING.md](CONTRIBUTING.md). + +## Troubleshooting + +For common issues and fixes, see [Troubleshoot OpenRAG](https://docs.openr.ag/support/troubleshoot). \ No newline at end of file diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index b9bb312a..0771b08e 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -18,7 +18,7 @@ OpenRAG has two Docker Compose files. Both files deploy the same applications an - Install the following: - - [Python](https://www.python.org/downloads/release/python-3100/) version 3.10 to 3.13. + - [Python](https://www.python.org/downloads/release/python-3100/) version 3.13 or later. - [uv](https://docs.astral.sh/uv/getting-started/installation/). - [Podman](https://podman.io/docs/installation) (recommended) or [Docker](https://docs.docker.com/get-docker/). - [`podman-compose`](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or [Docker Compose](https://docs.docker.com/compose/install/). To use Docker Compose with Podman, you must alias Docker Compose commands to Podman commands. diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 3c1c4bcc..921c94d6 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -22,7 +22,7 @@ If you prefer running Podman or Docker containers and manually editing `.env` fi ## Prerequisites -- All OpenRAG installations require [Python](https://www.python.org/downloads/release/python-3100/) version 3.10 to 3.13. +- All OpenRAG installations require [Python](https://www.python.org/downloads/release/python-3100/) version 3.13 or later. - If you aren't using the automatic installer script, install the following: diff --git a/docs/docs/get-started/quickstart.mdx b/docs/docs/get-started/quickstart.mdx index 80eb0902..2e333a14 100644 --- a/docs/docs/get-started/quickstart.mdx +++ b/docs/docs/get-started/quickstart.mdx @@ -18,7 +18,7 @@ This quickstart requires the following: This quickstart uses OpenAI for simplicity. For other providers, see the complete [installation guide](/install). -- [Python](https://www.python.org/downloads/release/python-3100/) version 3.10 to 3.13. +- [Python](https://www.python.org/downloads/release/python-3100/) version 3.13 or later. - Microsoft Windows only: To run OpenRAG on Windows, you must use the Windows Subsystem for Linux (WSL).