Installing PyPI packages

The basic way to install a package from binstar is using pip:

pip install --index-url pypi.binstar.org/REGISTRY-PATH/simple PACKAGE

Where REGISTRY-PATH may be one of the following:

1. A username, this allows installation of packages from a user registry: pip install --index-url pypi.binstar.org/USER/simple PACKAGE
   
   

   Note:
   the pypi user contains a full up to date mirror of pypi.python.org
   e.g. pypi.binstar.org/pypi

2. A user channel, this allows installation of packages from a collection of packages a user has put together: pip install --index-url pypi.binstar.org/USER/channel/channel-NAME/simple PACKAGE

   The main channel is the default channel: pypi.binstar.org/USER/channel/main/simple is equivalent to pypi.binstar.org/USER/simple

Installing Private Packages

All urls (except for the public registry) can be prefixed with /t/$TOKEN to access private packages.

TOKEN=$(binstar auth --create --name YOUR-TOKEN-NAME)
pip install --index-url pypi.binstar.org/t/$TOKEN/USER/simple PACKAGE

Modify your piprc file

pip allows you to set all command line option defaults in a standard ini style config file.

The names and locations of the configuration files vary slightly across platforms.

• On Unix and Mac OS X the configuration file is: $HOME/.pip/pip.conf
• On Windows, the configuration file is: %HOME%\pip\pip.ini

Appending options like --extra-index-url or --index-url can be written as:

[global]
extra-index-url =
    http://pypi.binstar.org/user/simple

[install]
extra-index-url =
    http://pypi.binstar.org/user2/simple

See also the official pip installer documentation

Authoring PyPI packages

All packages you author must go to a user account. To create a package go to binstar.org/new

See also authoring packages for a general overview.