Skip to content

Distribute benchx through conda-forge #108

Open

Description

@rok

Distribute benchx conda packages through conda-forge, so that conda install -c conda-forge benchx works. This repository won't build or upload conda packages itself: conda-forge builds them from a feedstock, which follows the releases on PyPI.

This depends on #105. The recipe takes its source from the PyPI sdist, so 0.1.0 has to be on PyPI first. Related: #76, which mentions a feedstock maintainers team.

Steps

  • Agree who maintains the feedstock, and collect their GitHub usernames.
  • After 0.1.0 is on PyPI, adapt the draft recipe (see below) and test it locally.
  • Open a PR adding recipes/benchx/ to conda-forge/staged-recipes, and ask @conda-forge/help-python to review it.
  • Once that merges, check that benchx-feedstock was created and the package was published. If the feedstock hasn't appeared after about a day, contact the conda-forge core team.
  • Test the install with conda install -c conda-forge benchx, and add it to the install instructions in docs/benchx.md.

Reviewers are volunteers, and the staged-recipes template warns that review can take days or weeks.

Requirements

From conda-forge's guide to adding packages:

Requirement Status
Source from a downloadable archive, with a SHA256 hash Needs the PyPI release
All dependencies on conda-forge Met when checked: pyarrow, jsonschema-with-format-nongpl, jsonpointer, referencing, rfc8785
SPDX license ID and the license file Met: Apache-2.0, and LICENSE is in the sdist
Tests, including imports, pip check and bx --help In the draft recipe
A maintainer Whoever submits becomes one, and others can be added

The name benchx was free on conda-forge when this issue was written.

Draft recipe

A draft recipe from #107 can be the starting point. It built from a local sdist with rattler-build, and passed its import and pip check tests and the full test suite on Python 3.11. It hasn't been checked against conda-forge's rules, and it needs these changes:

  • Version and source: replace the environment variables with a fixed version, the PyPI sdist URL and its SHA256. conda-forge suggests grayskull for generating Python recipes, which could be a useful comparison.
  • Maintainers: add an extra.recipe-maintainers section, as in their example recipe.
  • Python version: the draft sets python_min to 3.11 itself, while conda-forge also has a global python_min setting. benchx needs 3.11 or newer, so this needs checking against their current value and rules.
  • Comments: remove the instructional ones, as conda-forge asks.

After the feedstock exists

conda-forge's bot watches PyPI and opens a version update PR on the feedstock, usually within several hours of a release. Feedstock maintainers review and merge it, and update it by hand if benchx's dependencies changed. The bot stops opening PRs once three are open, so they can't be left to pile up. Its docs don't say how pre-releases are handled.

docs/releasing.md in #107 already includes this as a release step.

Open question

Who should maintain the feedstock? The proposal is the same people who can publish to PyPI, so one group handles every release.

Activity

  1. ev-br commented on Nov 6, 2026

    @ev-br
    Collaborator

    +1 from me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions