🛠️ Prerequisites

To use this repository, ensure you have the following installed:

1. Docker: Install [Docker Desktop].
2. Visual Studio Code: Install [VS Code].
3. DevContainers Extension: Install the [Dev Containers extension] in VS Code.

---

🏗️ Setup Instructions

1. Clone the Repository

2. Open in DevContainer

• Open the repository in VS Code.
• Use the Dev Containers extension to reopen the project in a container:
  1. Press Ctrl+Shift+P (or Cmd+Shift+P on macOS).
  2. Select Dev Containers: Reopen in Container.
  3. Some features of this repository require an OpenAI API key. Export the key as an environment variable:

🔧 Python Dependency Management

This repository uses pip-tools to manage Python dependencies.

Re-lock Python Packages

To update the requirements.txt file after modifying requirements.in, run:

pip-compile ./.devcontainer/requirements.dev.in --resolver=backtracking --generate-hashes --no-annotate --strip-extras --allow-unsafe --output-file=./.devcontainer/requirements.dev.txt

pip-compile pyproject.toml --resolver=backtracking --generate-hashes --no-annotate --strip-extras --output-file=requirements.txt