docs(setup): add just recipe and setup entry for uv
#10959
Conversation
| @@ -3,7 +3,7 @@ COPY --from=ghcr.io/astral-sh/uv:0.6.4 /uv /uvx /bin/ | |||
| ARG USERNAME=vscode | |||
|
|
|||
| RUN apt-get update && \ | |||
| apt-get install -y --no-install-recommends libgdal-dev && \ | |||
| apt-get install -y --no-install-recommends libgdal-dev python3-dev && \ | |||
There was a problem hiding this comment.
Required to avoid issues with psycopg2 when installing all dependencies - see https://stackoverflow.com/questions/19843945/psycopg-python-h-no-such-file-or-directory
There was a problem hiding this comment.
I would love to see this as an inline comment in the dockerfile, IDK what @cpcloud thinks though
There was a problem hiding this comment.
Yeah that'd be nice, but not a blocker!
| 1. Activate the virtual environment | ||
|
|
||
| ```sh | ||
| source .venv/bin/activate |
There was a problem hiding this comment.
This can't unfortunately be a just recipe - see https://byabbe.se/2024/02/21/using-python-virtual-environments-through-just
|
Thanks for the review! I've applied your suggestions for a simpler UI and adapted the PR header accordingly. |
|
|
||
| 1. [Install `uv`](https://docs.astral.sh/uv/getting-started/installation/) | ||
|
|
||
| 1. [Install `gh`](https://cli.github.com/manual/installation) |
There was a problem hiding this comment.
is gh only needed for the gh repo fork --clone call below? Or do the other justfile recipes require it? If it is only for this first step, I could see it being nice to removing this as a dependency: only instructing people to install uv, and then providing the raw git commands (would also need to instruct them to fork the repo, probably in the github web ui).
There was a problem hiding this comment.
Why would we want to replace a one liner with clicking on a web page?
There was a problem hiding this comment.
Sorry, I didn't mean to sound like a jerk there. After rereading what I wrote I realized it probably didn't come off exactly as I meant.
The original reason I chose gh is because it's the tool that lets you stay in one mode while setting everything up, whereas having people click to fork requires context switching. I don't see what we gain here by removing the gh dependency.
There was a problem hiding this comment.
Yeah no worrie! Sounds good to me, just wanted to throw it out there
|
Thanks @romaingd! I just had a few optional nits, but in general looks great, LGTM. |
Description of changes
Hi! This PR addresses #10554 by adding an entry for
uvto the "Setting up a development environment" tab panel.It also adds a new
just sync <backend>recipe, where<backend>is optional, to make installing the adequate dependencies easier. Better names are of course welcome!Issues closed