Rasa Python-SDK

Python SDK for the development of custom actions for Rasa Core.

Installation

To install the SDK run

pip install rasa_core_sdk

Compatibility

Usage

Detailed instructions can be found in the Rasa Core Documentation about Custom Actions.

Docker

Usage

In order to start an action server using implemented custom actions, you can use the available Docker image rasa/rasa_core_sdk:latest.

Before starting the action server ensure that the folder containing your actions is handled as Python module and therefore has to contain a file called __init__.py

Then start the action server using:

docker run -p 5055:5055 --mount type=bind,source=<ABSOLUTE_PATH_TO_YOUR_ACTIONS>,target=/app/actions \
	rasa/rasa_core_sdk:latest

The action server is then avaible at http://localhost:5055/webhook.

Custom Dependencies

To add custom dependencies you enhance the given Docker image, e.g.:

FROM rasa/rasa_core_sdk:latest

# To install system dependencies
RUN apt-get update -qq && \
    apt-get install -y <NAME_OF_REQUIRED_PACKAGE> && \
    apt-get clean && \
    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

# To install packages from PyPI
RUN pip install --no-cache-dir <A_REQUIRED_PACKAGE_ON_PYPI>

Code Style

To ensure a standardized code style we use the formatter black. If your code is not formatted properly, travis will fail to build.

If you want to automatically format your code on every commit, you can use pre-commit. Just install it via pip install pre-commit and execute pre-commit install.

If you want to set it up manually, install black via pip install black. To reformat files execute

black .

License

Licensed under the Apache License, Version 2.0. Copyright 2018 Rasa Technologies GmbH. Copy of the license.

A list of the Licenses of the dependencies of the project can be found at the bottom of the Libraries Summary.