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) in rattler-lock v6 format 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

https://conda-incubator.github.io/conda-workspaces/

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.3.0.tar.gz (14.8 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.3.0-py3-none-any.whl (76.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for conda_workspaces-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ff64e099babe0760fee84612ed9e20cba46ee6cfe1310a504dcf9f87e94dd4d9
MD5 308e556f0a34ca90729eace4a37bc4bd
BLAKE2b-256 3c2f43fa5cac55948c400180cb8aafac5c03e3836f1977a30a7c67c62e62e586

See more details on using hashes here.

Provenance

The following attestation bundles were made for conda_workspaces-0.3.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.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for conda_workspaces-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02887611f4e8bd11b54e55a3a60e4a324c7563170f2352b9d774aaa682cafa21
MD5 7c63d4f24b0a41fede6c50893ad21752
BLAKE2b-256 b773f309073f208743cc79d8660e1f804f9caa39a324b668a8d0f63ba43b6d35

See more details on using hashes here.

Provenance

The following attestation bundles were made for conda_workspaces-0.3.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