docs(contribute): include instructions to use Pixi #10504
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
deepyaman
force-pushed
the
docs/contribute/pixi-setup
branch
from
cbbbba8
to
1022a89
Compare
deepyaman
changed the title
deepyaman
commented
Nov 16, 2024
| if manager == "conda" or manager == "mamba": | ||
| print(f" {manager} install -c conda-forge gh") | ||
| elif manager == "pixi": | ||
| print(f" {manager} global install gh") |
There was a problem hiding this comment.
I didn't do this because I don't use gh, but wanted to keep things consistent...
deepyaman
commented
Nov 16, 2024
docs/contribute/01_environment.qmd
Outdated
| 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.
Alternatively, we could provide Pixi configuration in pyproject.toml (or pixi.toml), but this would be more involved to keep in sync; this approach worked well enough for me so far, with minimal effort.
ibis-docs-bot
bot
removed
the
docs-preview
ibis-docs-bot
bot
removed
the
docs-preview
ibis-docs-bot
bot
removed
the
docs-preview
deepyaman
force-pushed
the
docs/contribute/pixi-setup
branch
from
fbf85af
to
95e8c44
Compare
ibis-docs-bot
bot
removed
the
docs-preview
gforsyth
reviewed
Nov 18, 2024
| 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.
Where'd uv come from? Should this just be pip still?
There was a problem hiding this comment.
pipisn't installed by default in the environment created this way (I could, but...)- Since chore(dev-deps): move to
uvfor development #10424,uvis included inconda/environment.ymlanyway, so why not useuvoverpip? Seems there was a decision to generally move touv, and it's what's being used in CI.
There was a problem hiding this comment.
Ah, I didn't realize that uv had also been added to the yml files. All good, then!
gforsyth
approved these changes
Nov 19, 2024
|
Dunno about that nix job CI is waiting on but I'm going to merge this |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
Share how I set up my development environment using Pixi.