Package: rasafou
Rasa Open SourceRasa is an open source machine learning framework to automate text-and voice-based conversations. With Rasa, you can build contexual assistants on:Facebook MessengerSlackMicrosoft Bot FrameworkRocket.ChatMattermostTelegramTwilioYour own custom conversational channelsor voice assistants as:Alexa SkillsGoogle Home ActionsRasa helps you build contextual assistants capable of having layered conversations with
lots of back-and-forth. In order for a human to have a meaningful exchange with a contextual
assistant, the assistant needs to be able to use context to build on things that were previously
discussed – Rasa enables you to build assistants that can do this in a scalable way.There's a lot more background information in thisblog post.What does Rasa do? 🤔Check out our WebsiteI'm new to Rasa 😄Get Started with RasaI'd like to read the detailed docs 🤓Read The DocsI'm ready to install Rasa 🚀InstallationI want to learn how to use Rasa 🚀TutorialI have a question ❓Rasa Community ForumI would like to contribute 🤗How to ContributeWhere to get helpThere is extensive documentation in theRasa Docs.
Make sure to select the correct version so you are looking at
the docs for the version you installed.Please useRasa Community Forumfor quick answers to
questions.README Contents:How to contributeDevelopment InternalsLicenseHow to contributeWe are very happy to receive and merge your contributions. You can
find more information about how to contribute to Rasa (in lots of
different ways!)here.To contribute via pull request, follow these steps:Create an issue describing the feature you want to work on (or
have a look at thecontributor board)Write your code, tests and documentation, and format them withblackCreate a pull request describing your changesYour pull request will be reviewed by a maintainer, who will get
back to you about any necessary changes or questions. You will
also be asked to sign aContributor License Agreement.Development InternalsRunning and changing the documentationTo build & edit the docs, first install all necessary dependencies:pip3 install -r requirements-dev.txt
pip3 install -r requirements-docs.txtAfter the installation has finished, you can run and view the documentation
locally using:make livedocsVisit the local version of the docs athttp://localhost:8000in your browser.
You can now change the docs locally and the web page will automatically reload
and apply your changes.Running the TestsIn order to run the tests, make sure that you have the development requirements installed:exportPIP_USE_PEP517=falsepip3install-rrequirements-dev.txt
pip3install-e.
makeprepare-tests-ubuntu# Only on Ubuntu and Debian based systemsmakeprepare-tests-macos# Only on macOSThen, run the tests:maketestThey can also be run at multiple jobs to save some time:JOBS=[n]maketestWhere[n]is the number of jobs desired. If omitted,[n]will be automatically chosen by pytest.Steps to release a new versionReleasing a new version is quite simple, as the packages are build and distributed by GitHub Actions.Terminology:patch release (third version part increases): 1.1.2 -> 1.1.3minor release (second version part increases): 1.1.3 -> 1.2.0major release (first version part increases): 1.2.0 -> 2.0.0Release steps:Make sure all dependencies are up to date (especially Rasa SDK)Switch to the branch you want to cut the release from (masterin case of a major / minor, the current feature branch for patch releases)Runmake releaseCreate a PR against master or the release branch (e.g.1.2.x)Once your PR is merged, tag a new release (this SHOULD always happen on master or release branches), e.g. usinggittag1.2.0-m"next release"gitpushorigin1.2.0GitHub will build this tag and push a package topypiIf 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.xCode StyleTo ensure a standardized code style we use the formatterblack.
To ensure our type annotations are correct we use the type checkerpytype.
If your code is not formatted properly or doesn't type check, GitHub will fail to build.FormattingIf you want to automatically format your code on every commit, you can usepre-commit.
Just install it viapip install pre-commitand executepre-commit installin the root folder.
This will add a hook to the repository, which reformats files on every commit.If you want to set it up manually, install black viapip install -r requirements-dev.txt.
To reformat files executemake formatterType CheckingIf you want to check types on the codebase, installpytypeusingpip install -r requirements-dev.txt.
To check the types executemake typesDeploying documentation updatesWe usesphinx-versioningto build docs for tagged versions and for the master branch.
The static site that gets built is pushed to thedocsbranch of this repo, which doesn't contain
any code, only the site.We host the site on netlify. On master branch builds (see.github/workflows/documentation.yml), we push the built docs to thedocsbranch. Netlify automatically re-deploys the docs pages whenever there is a change to that branch.LicenseLicensed under the Apache License, Version 2.0.
Copyright 2020 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.