-
Notifications
You must be signed in to change notification settings - Fork 662
docs(setup): add just
recipe and setup entry for uv
#10959
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -246,6 +246,47 @@ for manager, params in managers.items(): | |
* `Rebuild Container` to copy files from the local Git repo and have the build | ||
run `uv sync`. | ||
|
||
## uv | ||
|
||
::: {.callout-warning} | ||
## `uv` will not handle installation of system dependencies | ||
|
||
`uv` will not install system dependencies needed for some packages such as `psycopg2` and `kerberos`. | ||
|
||
For a better development experience see the `conda/mamba` or `nix` setup instructions. | ||
::: | ||
|
||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is gh only needed for the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why would we want to replace a one liner with clicking on a web page? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah no worrie! Sounds good to me, just wanted to throw it out there |
||
|
||
1. Fork and clone the ibis repository: | ||
|
||
```sh | ||
gh repo fork --clone --remote ibis-project/ibis | ||
``` | ||
|
||
1. Change directory into `ibis`: | ||
|
||
```sh | ||
cd ibis | ||
``` | ||
|
||
1. Install development dependencies | ||
|
||
This will create a virtual environment at `.venv` and install all dependencies inside. | ||
It will also install Ibis in development mode as `ibis-framework`. | ||
|
||
```sh | ||
just sync | ||
``` | ||
|
||
1. Activate the virtual environment | ||
|
||
```sh | ||
source .venv/bin/activate | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This can't unfortunately be a |
||
``` | ||
|
||
## pip | ||
|
||
::: {.callout-warning} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Required to avoid issues with
psycopg2
when installing all dependencies - see https://stackoverflow.com/questions/19843945/psycopg-python-h-no-such-file-or-directoryThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that'd be nice, but not a blocker!