Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 2.44 KB

conda_or_pip.md

File metadata and controls

34 lines (25 loc) · 2.44 KB

Software Must Be Available with conda or pip

This is one of the tier 1 standards. See full list on the main page.

Short description

While users can download the software files and install the package with python setup.py install as described here, it is also possible to distribute the software by uploading it to package manager. This can allow the package installation process to be simple, single commands like pip install <package> and/or conda install <package>.

Importance of this standard

While packaging the software and having it available as an open source repository is a good way to let users access it, it can be made even easier by allowing the package to be installable with either pip or conda. Users will be able to use a single-line installation without needing prior knowledge of software, or having to download a copy of the software first.

Options for this standard

  • PyPi (the Python Package Index; this must be a Python package)
  • Conda via stenv (not language dependent)
  • Conda via Conda-Forge (not language dependent)

How to apply this standard

First, the package setup must be complete such that the software:

  • Is installable with python setup.py. See here for instructions.
  • Has a license file. See here for instructions.

To add your package to PyPi:

  • See these instructions from Python
  • Note that these tell you how to upload the package to Test PyPi as a check before uploading it to PyPi. We agree and recommend you install your package from Test PyPi and run your tests locally before determining if you're ready to upload to PyPi.

To add your package to stenv:

To add your package to Conda-Forge:

Useful Links