Uploading and installing conda packages#

To work with conda packages, you must use the corresponding subdomain https://conda.anaconda.org. To install conda packages from the user travis, for example, use the repository URL https://conda.anaconda.org/travis.

Uploading conda packages#

This example shows how to build and upload a conda package to Anaconda.org using conda build.

  1. Open Anaconda Prompt (Terminal on macOS/Linux).

  2. If necessary, install the anaconda-client and conda-build packages by running the following command:

    conda install anaconda-client conda-build
    
  3. Choose the repository for which you would like to build the package. In this example, we use a small public conda test package:

    # Replace <PACKAGE> with the package name
    git clone https://github.com/Anaconda-Platform/anaconda-client
    cd anaconda-client/<PACKAGE>/conda/
    

    In this directory, there are two required files, meta.yaml and build.sh.

    macOS and Linux systems are Unix systems. Packages built for Unix systems require a build.sh file, packages built for Windows require a bld.bat file, and packages built for both Windows and Unix systems require both a build.sh file and a bld.bat file. All packages require a meta.yaml file.

  4. To build the package, turn off automatic Client uploading and then run the conda build command:

    conda config --set anaconda_upload no
    conda build .
    

    All packages built in this way are placed in a subdirectory of the Anaconda conda-bld directory.

    Tip

    You can check where the resulting file was placed by adding the --output option:

    conda build . --output
    
  5. Upload the test package to Anaconda.org by running the anaconda upload command:

    anaconda login
    
    # Replace </PATH/TO/PACKAGE_NAME> with the correct file path and package name
    # Packages can be uploaded with .tar.bz2 or .conda compression formats
    anaconda upload </PATH/TO/PACKAGE_NAME>.tar.bz2
    anaconda upload </PATH/TO/PACKAGE_NAME>.conda
    

For more information on the .conda format, see Using the .conda compression format.

For more information on conda’s overall build framework, check out our article on Building conda packages.

Installing conda packages#

You can install conda packages from Anaconda.org by adding channels to your conda configuration.

Public channels#

  1. Open Anaconda Prompt (Terminal on macOS/Linux).

  2. Because conda knows how to interact with Anaconda.org, specifying the channel sean, for example, translates to https://anaconda.org/sean:

    conda config --add channels sean
    
  3. You can now install public conda packages from Sean’s Anaconda.org account. Try installing the testci package at https://anaconda.org/sean/testci:

    conda install testci
    

Private channels#

You can install a package from a private channel with a token and a Label:

# Replace <TOKEN> with the provided token
# Replace <CHANNEL> with a user channel
# Replace <LABEL_NAME> with the label name
# Replace <PACKAGE> with the name of the package you want to install
conda install -c https://conda.anaconda.org/t/<TOKEN>/<CHANNEL>/label/<LABEL_NAME> <PACKAGE>

Tokens are only required if the channel is private.

Finding help for uploading packages#

You can obtain a complete list of upload options, including:

  • Package channel.

  • Label.

  • Availability to other users.

  • Metadata.

To list the options, run the following in Anaconda Prompt (Terminal on macOS/Linux):

anaconda upload -h