From 1f00a5a70cc02539f170ee16b787b6ae45399276 Mon Sep 17 00:00:00 2001 From: Sean Gammage Date: Tue, 19 Aug 2025 20:46:55 -0500 Subject: [PATCH 1/2] Add insturctions for developing the application with containers --- docs/pages/contribution/contribution.md | 29 +++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/pages/contribution/contribution.md b/docs/pages/contribution/contribution.md index 33803adfe..04ff064fa 100644 --- a/docs/pages/contribution/contribution.md +++ b/docs/pages/contribution/contribution.md @@ -147,3 +147,32 @@ write better code faster. Here are some extensions that you might want to instal - Ruff: For formatting your code. - MDX: For the documentation website under `docs` folder. - Even Better TOML: For editing aact workflow files. + +## Using Dev Containers for development +You can use dev containers to make development consistent accross environments. It can be used with VS Code (preferred), other IDE's, or skip containers entirely. It is recommended to use VS Code as it is what Dev Containers was build for. Keeping a consistent IDE choice amongst developers also helps ensure we face less challenges. + +### Using VS Code (Recommended) + 1. Install VS Code + 1. Install the Dev Containers extension for VS Code + 1. Open the sotopia folder in VS Code + 1. When prompted, select "Reopen in Container." + + VS Code will build the container using the `.devcontainer` folder and open the workspace with all dependencies installed. From there, you can now run and test the project inside the container. + +### Other IDEs or Editors +Without VS Code, you will need to use basic Docker configurations. + 1. Assuming you have a docker-compose file, run: `docker-compose up` + 1. That should download all the necessary project requirement dependencies, and start the application (assuming the docker-file is properly configured) + +### Without Dev Containers +If you do not want to use containers, you can run everything directly on your machine. + 1. You'll need to ensure you have your pyproject.toml and / or requirments.txt files + 1. You'll need `poetry` or `pip` to install the project dependencies. + 1. Then you'll want to, create a virtual environment install the project dependencies: + ``` + python -m venv venv + source venv/bin/activate + + pip install -r requirements.txt + ``` + 1. From there you can run the application via it's entry point From 28fcab19e962962bc704e0aab621837f26a2d367 Mon Sep 17 00:00:00 2001 From: openhands Date: Fri, 19 Dec 2025 22:13:20 +0000 Subject: [PATCH 2/2] Update dev container instructions to use uv instead of poetry - Replace poetry/pip references with uv in the 'Without Dev Containers' section - Fix typos: 'accross' -> 'across', 'IDE's' -> 'IDEs', 'build' -> 'built', 'less' -> 'fewer' - Improve instructions for other IDEs to reference Dev Containers documentation - Make dependency installation consistent with existing uv workflow Co-authored-by: openhands --- docs/pages/contribution/contribution.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/docs/pages/contribution/contribution.md b/docs/pages/contribution/contribution.md index 04ff064fa..d5be197ea 100644 --- a/docs/pages/contribution/contribution.md +++ b/docs/pages/contribution/contribution.md @@ -149,7 +149,7 @@ write better code faster. Here are some extensions that you might want to instal - Even Better TOML: For editing aact workflow files. ## Using Dev Containers for development -You can use dev containers to make development consistent accross environments. It can be used with VS Code (preferred), other IDE's, or skip containers entirely. It is recommended to use VS Code as it is what Dev Containers was build for. Keeping a consistent IDE choice amongst developers also helps ensure we face less challenges. +You can use dev containers to make development consistent across environments. It can be used with VS Code (preferred), other IDEs, or skip containers entirely. It is recommended to use VS Code as it is what Dev Containers was built for. Keeping a consistent IDE choice amongst developers also helps ensure we face fewer challenges. ### Using VS Code (Recommended) 1. Install VS Code @@ -161,18 +161,15 @@ You can use dev containers to make development consistent accross environments. ### Other IDEs or Editors Without VS Code, you will need to use basic Docker configurations. - 1. Assuming you have a docker-compose file, run: `docker-compose up` - 1. That should download all the necessary project requirement dependencies, and start the application (assuming the docker-file is properly configured) + 1. Please refer to [Dev Containers](https://containers.dev/supporting#editors) to see how to set up Dev Containers in other editors + 1. Alternatively, you can use the Docker setup directly if your editor supports it ### Without Dev Containers If you do not want to use containers, you can run everything directly on your machine. - 1. You'll need to ensure you have your pyproject.toml and / or requirments.txt files - 1. You'll need `poetry` or `pip` to install the project dependencies. - 1. Then you'll want to, create a virtual environment install the project dependencies: + 1. You'll need to ensure you have Python 3.10+ and install uv using `pip install uv` + 1. You'll need `uv` to install the project dependencies. + 1. Install all dependencies using uv: ``` - python -m venv venv - source venv/bin/activate - - pip install -r requirements.txt + uv sync --all-extras ``` - 1. From there you can run the application via it's entry point + 1. From there you can run the application and tests using uv commands