.. _installation_package:

Python package installation
===========================

The enterprise version of the python Rasa packages are hosted on a private
pypi server (instead of the publicly available instance that ``pip install``
uses by default).

To access these dependencies when developing an application locally or
when building containers in a CI environment you need to

1. create an account to access the private packages
2. add your credentials before trying to pull packages with ``pip install``


Access to private Rasa pip repository
-------------------------------------

Your license file (``rasa_platform.yml``) contains authentication
credentials for the private python package registry of Rasa.

Your default credentials are contained in the fields
``pypi_repository_password`` and ``pypi_repository_user``
in your license file.

**Optionally**, you can register additional accounts,
if you need them, at https://pypi.rasa.ai/login .
Choose a username and submit your account for approval by clicking ``Register``.

After you completed your account registration, please use your support
email address to inform us of your account creation so we can validate your
additional accounts.

Setting up pip authentication
-----------------------------

You can manually enter your credentials and ``pip`` will ask for the
credentials, e.g.

.. code-block:: bash

    > pip install -i https://pypi.rasa.ai/simple/ rasa-extensions
    Collecting rasa-extensions
    User for pypi.rasa.ai: test
    Password:

To automate this, you can add your credentials to your ``~/.pypirc``:

.. code-block:: ini

    # ~/.pypirc
    [distutils]
    index-servers =
        pypi
        rasa

    [pypi] # https://www.python.org/pypi
    username:
    password:

    [rasa]
    repository: https://pypi.rasa.ai/simple/
    username: USERNAME
    password: PASSWORD

Replacing ``USERNAME`` and ``PASSWORD`` with your authentication credentials.