Skip to content

docs: document conda-forge availability#120

Merged
SMI-Lab-Inha merged 1 commit into
masterfrom
docs/conda-forge-availability
Jun 8, 2026
Merged

docs: document conda-forge availability#120
SMI-Lab-Inha merged 1 commit into
masterfrom
docs/conda-forge-availability

Conversation

@SMI-Lab-Inha

Copy link
Copy Markdown
Owner

pyBmodes is now packaged on conda-forge (conda-forge/staged-recipes#33448 merged), so conda install -c conda-forge pybmodes works alongside pip install pybmodes. This documents the new install channel.

Changes

  • README
    • Added the conda-forge version badge.
    • Install section now shows both the pip and the conda-forge commands.
    • Rewrote the "Using a conda environment?" note, which previously said pyBmodes was not on conda-forge, to lead with the conda install and upgrade path, plus how to add matplotlib / pyyaml for the optional features. Kept the pip-into-conda workflow as a fallback.
    • Updated the documentation table to mention conda-forge.
  • docs/installation.rst
    • New "From conda-forge" section after "From PyPI".
    • Rewrote "Inside a conda environment" to use conda-forge directly, with the pip-in-conda case kept as a secondary note.
  • CHANGELOG
    • Unreleased entry recording conda-forge availability.

No code or API changes.

pyBmodes is now packaged on conda-forge. Update the README and the
installation guide to show the conda install and upgrade path
alongside pip, explain how to add the optional dependencies the pip
extras would otherwise pull in (matplotlib, pyyaml), and add a
conda-forge version badge. Record the availability under the
Unreleased changelog heading.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 99e500eaf4

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/installation.rst

.. code-block:: bash

conda install -c conda-forge pybmodes

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Do not publish conda install instructions before availability

This new installation path currently points users at a package that is not actually available yet: the staged-recipes PR was merged, but https://github.com/conda-forge/pybmodes-feedstock still returns 404 and searches for conda-forge/pybmodes only find the staged recipe / PyPI pages, not an installable Anaconda.org package. Until the feedstock is created and the noarch artifact is uploaded, users following this command will get a package-not-found error, so the docs should either wait for the package to exist or phrase this as pending.

Useful? React with 👍 / 👎.

@SMI-Lab-Inha SMI-Lab-Inha merged commit 9067c4d into master Jun 8, 2026
6 checks passed
@SMI-Lab-Inha SMI-Lab-Inha deleted the docs/conda-forge-availability branch June 8, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant