Skip to main content

Project-scoped multi-environment workspace management for conda, with pixi compatibility

Project description

conda-workspaces

Tests Docs PyPI conda-forge Codecov License Python

Project-scoped multi-environment workspaces and task runner for conda, with pixi manifest compatibility.

Define environments and tasks in your project manifest, compose environments from reusable features, and let conda handle the solving and installation. Works with existing pixi manifests -- no new package manager required.

Quick start

quickstart demo

Create a conda.toml in your project root:

[workspace]
name = "my-project"
channels = ["conda-forge"]
platforms = ["linux-64", "osx-arm64", "win-64"]

[dependencies]
python = ">=3.10"
numpy = ">=1.24"

[feature.test.dependencies]
pytest = ">=8.0"
pytest-cov = ">=4.0"

[environments]
test = { features = ["test"] }

[tasks]
test = { cmd = "pytest tests/ -v", description = "Run the test suite" }
lint = "ruff check ."

[tasks.check]
depends-on = ["test", "lint"]

Install and manage your environments, then run tasks:

$ conda workspace install              # solve + install + generate conda.lock
$ conda workspace envs                 # list defined environments
$ conda task run check                 # runs lint and test in dependency order
$ conda workspace shell -e test        # spawn a shell with test env activated
$ conda workspace install --locked     # reproducible install from conda.lock

Why?

Conda handles environments and packages. pixi introduced a great project model with multi-environment workspaces and a task runner, but it brings its own solver and environment management.

conda-workspaces reads pixi-compatible manifests and delegates solving and installation to conda's own infrastructure. You get workspace management and task running inside the conda CLI without switching tools.

What it does

  • Reads conda.toml, pixi.toml, and pyproject.toml workspace manifests
  • Multi-environment support with composable features
  • Project-local environments in .conda/envs/
  • Lockfile generation (conda.lock) using a rattler-lock-derived schema for reproducible installs
  • Per-platform dependency overrides via [target.<platform>]
  • PyPI dependencies translated and resolved alongside conda packages via conda-pypi
  • Activation scripts and environment variables per feature
  • System requirements as virtual package constraints
  • Per-workspace channel priority override
  • Task dependencies with topological ordering (depends-on)
  • Jinja2 templates in commands ({{ conda.platform }}, conditionals)
  • Task arguments with defaults, input/output caching, and per-platform overrides
  • conda workspace / conda task subcommands (also available as cw / ct aliases)

Installation

conda install -c conda-forge conda-workspaces

CLI

conda-workspaces registers conda workspace and conda task subcommands, and also provides cw and ct as shorter aliases.

Workspace commands

Command Description
conda workspace init Initialize a new workspace manifest
conda workspace install Create/update workspace environments
conda workspace install --locked Install from lockfile (skip solving)
conda workspace lock Generate/update conda.lock
conda workspace list List packages in an environment
conda workspace envs List defined environments
conda workspace info [ENV] Show environment details
conda workspace add SPECS... Add dependencies
conda workspace remove SPECS... Remove dependencies
conda workspace shell [ENV] Spawn a shell with an environment activated
conda workspace activate [ENV] Print activation instructions
conda workspace clean Remove installed environments

Task commands

Command Description
conda task run TASK Run a task (with dependency resolution)
conda task list List available tasks
conda task add NAME CMD Add a task to the manifest
conda task remove NAME Remove a task from the manifest
conda task export Export tasks to conda.toml format

What it doesn't do

conda-workspaces is a workspace manager and task runner, not a package manager replacement. It does not bundle its own solver or bypass conda's installation machinery. If you want a fully integrated tool that handles everything including its own solver, see pixi.

Documentation

Demos

See demos/README.md for animated terminal recordings of workspace and task features.

Development

pixi install
pixi run test
pixi run lint

Acknowledgements

The workspace and task system in conda-workspaces is directly inspired by the work of the prefix.dev team on pixi. Their design of workspace manifests, features, environments, platform targeting, task dependencies, caching, and template variables provided the blueprint for this plugin.

License

BSD 3-Clause. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

conda_workspaces-0.5.0.tar.gz (47.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

conda_workspaces-0.5.0-py3-none-any.whl (114.4 kB view details)

Uploaded Python 3

File details

Details for the file conda_workspaces-0.5.0.tar.gz.

File metadata

  • Download URL: conda_workspaces-0.5.0.tar.gz
  • Upload date:
  • Size: 47.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for conda_workspaces-0.5.0.tar.gz
Algorithm Hash digest
SHA256 b074cc8b879547eda414a22e72358ef082db01d4c1a72a1f1772ef7aa59a085e
MD5 c16722410a3a514b936170f29ba71b8b
BLAKE2b-256 3cc04c0bb50b611fd2d3abe16ddd63267fa2607009bdf6fddc26b5f488f9b560

See more details on using hashes here.

Provenance

The following attestation bundles were made for conda_workspaces-0.5.0.tar.gz:

Publisher: release.yml on conda-incubator/conda-workspaces

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file conda_workspaces-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for conda_workspaces-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a5495751c219225ee8acb2f6daed37a5d240f6be4138fba0faa300bcd11a496
MD5 343793bc0e977c66873460bba04c7e73
BLAKE2b-256 df599538eb39d7c2b6d80fe1051087f54f82811fb4e70f44b09531f6b584d2ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for conda_workspaces-0.5.0-py3-none-any.whl:

Publisher: release.yml on conda-incubator/conda-workspaces

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page