Skip to content
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

Create a first draft pixi migration guide #708

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
Prev Previous commit
Add ibis example
  • Loading branch information
maresb committed Sep 16, 2024
commit 2c62c8f74a79ea15714f8dcb400c6ebae8756cf2
27 changes: 27 additions & 0 deletions docs/pixi-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,33 @@ Perhaps "migration" is the wrong word, because pixi is an option, not a replacem
It will not override existing workflows.
Removing pixi from your project is as simple as deleting the files indicated in step 2 below.

## Quick example

Use conda-lock and pixi to make a development environment for ibis.

```sh
pipx upgrade conda-lock || pipx install --force "conda-lock>=3"
cd /tmp
git clone https://github.com/ibis-project/ibis.git
cd ibis
git checkout -b add-pixi
echo .pixi >> .gitignore
git add .gitignore
git commit -m "Ignore pixi cache directory"
conda-lock render-lock-spec --kind=pixi.toml --stdout \
--file=pyproject.toml \
--channel=conda-forge \
--pixi-project-name=ibis \
--editable ibis=. \
> pixi.toml
git add pixi.toml
git commit -m "Add pixi.toml configuration"
pixi update
git add pixi.lock
git commit -m "Add pixi.lock lock file"
pixi shell
```

## The steps to get started

1. Visit <https://pixi.sh> and install pixi if you haven't already.
Expand Down
Loading