https://github.com/langroid/langroid-template
Template for langroid-based projects
https://github.com/langroid/langroid-template
Last synced: 6 days ago
JSON representation
Template for langroid-based projects
- Host: GitHub
- URL: https://github.com/langroid/langroid-template
- Owner: langroid
- Created: 2024-12-27T16:44:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-18T21:05:40.000Z (over 1 year ago)
- Last Synced: 2026-05-21T22:25:15.615Z (about 1 month ago)
- Language: Python
- Size: 196 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Template for a Langroid-based project
Example project using the [Langroid](https://github.com/langroid/langroid) Multi-Agent
Programming framework to build LLM applications.
## How to use this template
On GitHub, click on the green "Use this template" button to create a new repo
based on this template.
## Set up various keys in the `.env` file or as environment variables
Typically your `.env` file should look something like this:
```bash
GEMINI_API_KEY=your_key
OPENAI_API_KEY=your_key
```
## Use `uv` to manage Python dependencies and virtual env
Install `uv`, see [here](https://docs.astral.sh/uv/getting-started/installation/)
## Change the project name
If your specific project name is `myproject`, then:
- Change `example` to your specific project name in the `pyproject.toml` file.
- rename the `example` folder to `myproject`
## Scripts
Have any useful scripts in the `scripts` folder, and edit the
`[project.scipts]` section in the `pyproject.toml` file to include paths to these scripts, so they can be run with `uv run `.
You can declare script dependencies via metadata at the top of the script file , see [here](https://docs.astral.sh/uv/guides/scripts/#creating-a-python-script)
## Create virtual env and install dependencies
Then create a virtual env, activate it and install the dependencies:
```bash
uv venv --python 3.11
. ./.venv/bin/activate
uv sync
```