-
Notifications
You must be signed in to change notification settings - Fork 598
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
docs(contribute): include instructions to use Pixi #10504
Changes from 1 commit
1022a89
ad5f6c4
95e8c44
3452844
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 |
---|---|---|
|
@@ -18,7 +18,7 @@ the `conda/mamba` setup and refer to the comment related to `arm64` | |
architectures. | ||
::: | ||
|
||
## Conda/Mamba | ||
## Conda/Mamba/Pixi | ||
|
||
### Support matrix [^conda-callout] | ||
|
||
|
@@ -45,6 +45,10 @@ managers = { | |
"name": "Mamba", | ||
"url": "https://github.com/mamba-org/mamba", | ||
}, | ||
"pixi": { | ||
"name": "Pixi", | ||
"url": "https://pixi.sh/latest/", | ||
}, | ||
} | ||
|
||
for manager, params in managers.items(): | ||
|
@@ -58,7 +62,10 @@ for manager, params in managers.items(): | |
print(f"1. Install `gh`") | ||
print() | ||
print(" ```sh") | ||
print(f" {manager} install -c conda-forge gh") | ||
if manager == "conda" or manager == "mamba": | ||
print(f" {manager} install -c conda-forge gh") | ||
elif manager == "pixi": | ||
print(f" {manager} global install gh") | ||
print(" ```") | ||
print() | ||
print(f"1. Fork and clone the ibis repository:") | ||
|
@@ -67,37 +74,48 @@ for manager, params in managers.items(): | |
print(" gh repo fork --clone --remote ibis-project/ibis") | ||
print(" ```") | ||
print() | ||
print(f"1. Create a Conda environment using `environment.yml`") | ||
print(f"1. Create a {name} environment using `environment.yml`") | ||
print() | ||
print(" ```sh") | ||
print(" cd ibis") | ||
print(f" {manager} env create --file conda/environment.yml") | ||
if manager == "conda" or manager == "mamba": | ||
print(f" {manager} env create --file conda/environment.yml") | ||
elif manager == "pixi": | ||
print(f" {manager} init --import conda/environment.yml") | ||
print(" ```") | ||
print() | ||
if manager == "conda" or manager == "mamba": | ||
print() | ||
print( | ||
" If you're using arm64 architecture (Mac M1/M2), use " | ||
"`conda/environment-arm64.yml` for setting up a dev environment for all the " | ||
"backends that are possible to install excluding Flink; use " | ||
"`conda/environment-arm64-flink.yml` for setting up a dev environment for all " | ||
"the backends that are possible to install including Flink. The reason to have " | ||
"two separate environments is because `apache-flink` forces `pyarrow` to " | ||
"downgrade to 11.0, which causes conflicts in other backends." | ||
) | ||
print( | ||
" If you're using arm64 architecture (Mac M1/M2), use " | ||
"`conda/environment-arm64.yml` for setting up a dev environment for all the " | ||
"backends that are possible to install excluding Flink; use " | ||
"`conda/environment-arm64-flink.yml` for setting up a dev environment for all " | ||
"the backends that are possible to install including Flink. The reason to have " | ||
"two separate environments is because `apache-flink` forces `pyarrow` to " | ||
"downgrade to 11.0, which causes conflicts in other backends." | ||
) | ||
print() | ||
if manager == "pixi": | ||
print(" ::: {.callout-note}") | ||
print(" This command will initialize a `pixi.toml` file and also modify ") | ||
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. Alternatively, we could provide Pixi configuration in |
||
print(" the `.gitignore` to prevent Pixi configuration from being added to ") | ||
print(" `git`.") | ||
print(" :::") | ||
print() | ||
print(f"1. Activate the environment") | ||
print() | ||
print(" ```sh") | ||
print(f" {manager} activate ibis-dev") | ||
if manager == "conda" or manager == "mamba": | ||
print(f" {manager} activate ibis-dev") | ||
elif manager == "pixi": | ||
print(f" {manager} shell") | ||
print(" ```") | ||
print() | ||
print( | ||
f"1. Install your local copy of `ibis` into the {manager.capitalize()} environment" | ||
) | ||
print() | ||
print(" ```sh") | ||
print(" pip install -e .") | ||
print(" uv pip install -e .") | ||
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. Where'd 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.
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. Ah, I didn't realize that |
||
print(" ```") | ||
print() | ||
``` | ||
|
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.
I didn't do this because I don't use
gh
, but wanted to keep things consistent...