Skip to content

kevinlin/rag-workshop

Repository files navigation

Project Title

A brief description of your project.

Development Setup (using uv)

This section describes how to set up a development environment using uv.

1. Install uv

uv is a fast Python package installer and resolver, written in Rust. You can install it by running one of the following commands in your terminal:

Using curl:

curl -LsSf https://astral.sh/uv/install.sh | sh

Or, if you have pip installed:

pip install uv

For other installation methods, please refer to the official uv documentation.

2. Run the Setup Script

Once uv is installed, navigate to the root of this repository and run the setup script:

sh setup_uv_env.sh

This script will:

  • Create a virtual environment named .venv in the project root.
  • Activate the virtual environment.
  • Install all necessary dependencies from requirements.txt.
  • Install all development dependencies from requirements-dev.txt.

3. Activate the Virtual Environment

After the script completes, the virtual environment .venv will be created. To activate it in your current terminal session, run:

source .venv/bin/activate

You should now see (.venv) at the beginning of your terminal prompt, indicating that the virtual environment is active. You can now run the application and development tools.

To deactivate the virtual environment, simply run:

deactivate

Other Sections

(You can add other sections here, like "Usage", "Running Tests", "Deployment", etc.)

About

Template RAG Application for Workshop

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •