conda-ship#

Build ready-to-run conda runtimes.

conda-ship is a generic builder for single-binary conda runtimes. It installs the cs CLI, but it does not ship a first-party distribution. Downstream projects choose the runtime name, delegate executable, package set, channels, documentation URL, and release channel.

conda-express is one downstream distribution maintained by Jannis Leidel: it uses conda-ship to build the cx and cxz runtimes. conda-ship owns the reusable builder; conda-express owns the product defaults and release channels for cx.

Start Here#

If you are new to conda-ship, start with the quickstart. It creates a small conda workspace, locks it, and stages a demo runtime:

conda create -n cs-demo -c conda-forge python pip conda-workspaces
conda activate cs-demo
python -m pip install conda-ship
mkdir demo-runtime
cd demo-runtime

Then follow the quickstart, or use the documentation by the kind of help you need.

Common Workflows#

Quickstart

Build an online runtime artifact from a small conda workspace.

Quickstart
First Runtime

Build a small conda runtime and smoke-test the generated binary.

Build Your First Runtime
GitHub Actions Runtime

Build release artifacts from CI with a platform matrix.

Build A Runtime In GitHub Actions
Custom Delegate Runtime

Expose a command other than conda through the generated runtime.

Build A Runtime With A Custom Delegate

Documentation By Need#

Learn

Follow a guided first build from lockfile to smoke test.

Build Your First Runtime
Do

Build a downstream runtime with your own package set.

Customize A Runtime
Look Up

Find exact commands, options, artifact names, and configuration keys.

Builder CLI Reference
Understand

Read the builder/runtime model and where conda-ship fits in the conda ecosystem.

Concepts

Example Distribution#

conda-ship

Read what the builder owns and what downstream distributions own.

Project Boundaries
conda-express

See a concrete downstream distribution built with conda-ship.

https://jezdez.github.io/conda-express/