docs: document conda-forge availability#120
Conversation
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.
There was a problem hiding this comment.
💡 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".
|
|
||
| .. code-block:: bash | ||
|
|
||
| conda install -c conda-forge pybmodes |
There was a problem hiding this comment.
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 👍 / 👎.
pyBmodes is now packaged on conda-forge (conda-forge/staged-recipes#33448 merged), so
conda install -c conda-forge pybmodesworks alongsidepip install pybmodes. This documents the new install channel.Changes
matplotlib/pyyamlfor the optional features. Kept the pip-into-conda workflow as a fallback.No code or API changes.