-
Notifications
You must be signed in to change notification settings - Fork 99
[DOCS] Modernize installation page to cover uv, pixi, and pip #717
Copy link
Copy link
Open
Labels
Documentation 📚Changes to docstrings or the documentation site. No codebase changes.Changes to docstrings or the documentation site. No codebase changes.Effort > Moderate 🐕Mid-sized tasks estimated to take a few days to a few weeks.Mid-sized tasks estimated to take a few days to a few weeks.Impact > Minor 🔷Small, backward compatible change. Treat like a patch release (e.g., 0.5.8 → 0.5.9).Small, backward compatible change. Treat like a patch release (e.g., 0.5.8 → 0.5.9).
Metadata
Metadata
Assignees
Labels
Documentation 📚Changes to docstrings or the documentation site. No codebase changes.Changes to docstrings or the documentation site. No codebase changes.Effort > Moderate 🐕Mid-sized tasks estimated to take a few days to a few weeks.Mid-sized tasks estimated to take a few days to a few weeks.Impact > Minor 🔷Small, backward compatible change. Treat like a patch release (e.g., 0.5.8 → 0.5.9).Small, backward compatible change. Treat like a patch release (e.g., 0.5.8 → 0.5.9).
Current state
docs/getting_started/install.mdonly coverspip install chainladder. Modern Python projects (e.g. https://ibis-project.org/install) typically present a matrix of package managers so users can choose the one that matches their environment.Proposal
Restructure the install page into three sections, in this order, with
uvandpixirecommended for new users andpipretained for backward compatibility and existing workflows:uv add chainladder(recommended, fastest, modern default)pixi add chainladder(recommended for conda/mamba users)pip install chainladder(works everywhere, including legacy environments)Verified install commands
pip install chainladderuv add chainladderpixi add chainladderAll three resolve and import cleanly. The pixi version is older (see below).
Prerequisite: keep the conda-forge feedstock in sync with PyPI
The conda-forge recipe (https://github.com/conda-forge/chainladder-feedstock) is currently at 0.8.26, while PyPI is at 0.9.1. The autotick bot (
regro-cf-autotick-bot) is already enabled on the feedstock and has opened PR #31 with the v0.9.1 update, but the PR has not yet been merged.Two related fixes would close the gap:
@conda-forge-admin, please add bot automergein the title. Once added, future autotick bot PRs (one per release) will merge automatically if the recipe lints clean and tests pass, eliminating manual review delay.With automerge in place, every PyPI release would land on conda-forge within hours, and the install page can confidently recommend pixi without a version-lag caveat.
Out of scope for this issue
docs/library/contributing.mdalready documents theuv syncdev workflow.