You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+15-23Lines changed: 15 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,34 +29,26 @@ We will review PRs when possible and work with you to integrate your contributio
29
29
30
30
## Running Your Local Fork
31
31
32
-
**Note: for anyone testing the new `--local`, `--os`, and `--local --os` modes: When you run `poetry install` you aren't installing the optional dependencies and it'll throw errors. To test `--local` mode, run `poetry install -E local`. To test `--os` mode, run `poetry install -E os`. To test `--local --os` mode, run `poetry install -E local -E os`. You can edit the system messages for these modes in `interpreter/terminal_interface/profiles/defaults`.**
33
-
34
-
Once you've forked the code and created a new branch for your work, you can run the fork in CLI mode by following these steps:
35
-
36
-
1. CD into the project folder by running `cd open-interpreter`.
37
-
2. Install `poetry`[according to their documentation](https://python-poetry.org/docs/#installing-with-pipx), which will create a virtual environment for development + handle dependencies.
38
-
3. Install dependencies by running `poetry install`.
39
-
4. Run the program with `poetry run interpreter`. Run tests with `poetry run pytest -s -x`.
32
+
**Note: optional dependencies for the `--local`, `--os`, and `--local --os` modes are not installed by default. Use `uv sync --extra local`, `uv sync --extra os`, or `uv sync --extra local --extra os` to include them. You can edit the system messages for these modes in `interpreter/terminal_interface/profiles/defaults`.**
33
+
34
+
Once you've forked the code and created a new branch for your work, you can run the fork in CLI mode by following these steps:
35
+
36
+
1. CD into the project folder by running `cd open-interpreter`.
37
+
2. Install `uv`[according to their documentation](https://docs.astral.sh/uv/getting-started/installation/).
38
+
3. Install dependencies (including dev tools) with `uv sync --group dev`. Add `--extra <name>` flags if you need optional extras.
39
+
4. Run the program with `uv run interpreter`. Run tests with `uv run pytest -s -x`.
40
40
41
41
**Note**: This project uses [`black`](https://black.readthedocs.io/en/stable/index.html) and [`isort`](https://pypi.org/project/isort/) via a [`pre-commit`](https://pre-commit.com/) hook to ensure consistent code style. If you need to bypass it for some reason, you can `git commit` with the `--no-verify` flag.
42
42
43
43
### Installing New Dependencies
44
44
45
-
If you wish to install new dependencies into the project, please use `poetry add package-name`.
46
-
47
-
### Installing Developer Dependencies
48
-
49
-
If you need to install dependencies specific to development, like testing tools, formatting tools, etc. please use `poetry add package-name --group dev`.
50
-
51
-
### Known Issues
52
-
53
-
For some, `poetry install` might hang on some dependencies. As a first step, try to run the following command in your terminal:
Then run `poetry install` again. If this doesn't work, please join our [Discord community](https://discord.gg/6p3fD6rBVm) for help.
58
-
59
-
## Code Formatting and Linting
45
+
If you wish to install new dependencies into the project, please use `uv add package-name`.
46
+
47
+
### Installing Developer Dependencies
48
+
49
+
If you need to install dependencies specific to development, like testing tools, formatting tools, etc. please use `uv add package-name --group dev`.
50
+
51
+
## Code Formatting and Linting
60
52
61
53
Our project uses `black` for code formatting and `isort` for import sorting. To ensure consistency across contributions, please adhere to the following guidelines:
0 commit comments