Skip to content

Document a "uv" based development environment #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
johbo wants to merge 1 commit into from
Closed

Document a "uv" based development environment #247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,31 @@ git clone https://github.com/Aider-AI/aider.git
cd aider
```

### Create a Virtual Environment
### Using uv (Recommended)

The easiest way to get started is using [uv](https://docs.astral.sh/uv/). `uv` handles Python versions, virtual environments, and dependencies automatically.

To start a development shell with all dependencies installed:

```
uv run --extra dev bash
# or
uv run --extra dev zsh
```

To run tests:

```
uv run --extra dev pytest
```

To run the CLI to test your changes:

```
uv run cecli
```

### Manual Setup: Create a Virtual Environment

It is recommended to create a virtual environment outside of the repository to keep your development environment isolated.

Expand Down