Package: rasa-sdk
Rasa Python-SDKPython SDK for the development of custom actions for Rasa.💡We're migrating issues to Jira💡Starting January 2023, issues for Rasa Open Source are located inthis Jira board. You can browse issues without being logged in;
if you want to create issues, you'll need to create a Jira account.InstallationTo install the SDK runpipinstallrasa-sdkCompatibilityrasa-sdkpackage:SDK versioncompatible Rasa version1.0.x>=1.0.xoldrasa_core_sdkpackage:SDK versioncompatible Rasa Core version0.12.x>=0.12.x0.11.x0.11.xnot compatible<=0.10.xUsageDetailed instructions can be found in the Rasa Documentation aboutCustom Actions.DockerUsageIn order to start an action server using implemented custom actions,
you can use the available Docker imagerasa/rasa-sdk.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__.pyThen start the action server using:dockerrun-p5055:5055--mounttype=bind,source=<ABSOLUTE_PATH_TO_YOUR_ACTIONS>,target=/app/actions\rasa/rasa-sdk:<version>The action server is then available athttp://localhost:5055/webhook.Custom DependenciesTo add custom dependencies you enhance the given Docker image, e.g.:# Extend the official Rasa SDK image
FROM rasa/rasa-sdk:<version>

# Change back to root user to install dependencies
USER root

# 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>

# Switch back to non-root to run code
USER 1001Building from sourceRasa SDK uses Poetry for packaging and dependency management. If you want to build it from source,
you have to install Poetry first. This is how it can be done:curl -sSL https://install.python-poetry.org | python3 -There are several other ways to install Poetry. Please, followthe official guideto see all possible options.To install dependencies andrasa-sdkitself in editable mode executemake installCode StyleTo ensure a standardized code style we use the formatterblack.
If your code is not formatted properly, GitHub CI will fail to build.If you want to automatically format your code on every commit, you can usepre-commit.
Just install it viapip install pre-commitand executepre-commit install.To check and reformat files executemake lintSteps to release a new versionReleasing a new version is quite simple, as the packages are build and distributed
by GitHub Actions.Release steps:Switch to the branch you want to cut the release from (mainin case of a
major / minor, the current release branch for patch releases).If this is a minor / major release: Make sure all fixes from currently supported minor versions have been merged from their respective release branches (e.g. 3.3.x) back into main.Runmake releaseCreate a PR against main or the release branch (e.g.1.2.x)Once your PR is merged, pull the release branch locally.Create a tag for a new release (this SHOULD always happen onmainor release branches), e.g. usinggittag1.2.0-m"next release"gitpushorigin1.2.0GitHub Actions will build this tag and push a package topypi.If this is a minor release, a new release branch should be created
pointing to the same commit as the tag to allow for future patch releases,
e.g.gitcheckout-b1.2.x
gitpushorigin1.2.xLicenseLicensed under the Apache License, Version 2.0. Copyright 2021 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 theLibraries Summary.