Skip to content
πŸ’¬ Open source machine learning framework to automate text- and voice-based conversations: NLU, dialogue management, connect to Slack, Facebook, and more - Create chatbots and voice assistants
Python Other
  1. Python 99.6%
  2. Other 0.4%
Branch: master
Clone or download
Latest commit 9a75a8b Aug 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github updating changelog part of 'definition of done' Aug 6, 2019
alt_requirements Small text edit Jul 31, 2019
binder Merge branch 'master' into eval_model_unload_fix Apr 1, 2019
data add test for printing form stories Aug 22, 2019
docker Merge branch 'master' into sdk-rename May 13, 2019
docs merge master Aug 22, 2019
examples Merge branch 'fix_interactive' of https://github.com/RasaHQ/rasa into… Aug 22, 2019
heroku Redesigned docker config and requirement/directory layout Jul 26, 2017
rasa Merge branch 'master' into refactor-tf Aug 23, 2019
rasa_core fixed spelling errors May 13, 2019
rasa_nlu fixed spelling errors May 13, 2019
sample_configs Add types. May 7, 2019
test_models return test_model_dir Feb 27, 2019
tests Merge branch 'master' into refactor-tf Aug 22, 2019
.codeclimate.yml Review comments. Apr 11, 2019
.coveragerc Merge branch 'master' into eval_model_unload_fix Apr 1, 2019
.dockerignore Changes to get manual-testing of docker working Jul 27, 2017
.env dumy .env files Nov 14, 2016
.gitattributes fixes docker error on windows: standard_init_linux.go:178: exec Jul 5, 2017
.gitignore Merge branch 'master' into master Aug 1, 2019
.pre-commit-config.yaml Add pre-commit. Apr 8, 2019
.travis.yml rasabaster now 0.7.23 instead of 22 Aug 7, 2019
CHANGELOG.rst merge master Aug 22, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Sep 13, 2017
Dockerfile improved auxillary docker files Apr 25, 2019
LICENSE.txt added rasa stack files Mar 13, 2019
MANIFEST.in update path to default config in manifest.in May 8, 2019
Makefile Make install instructions shorter. Jul 12, 2019
NOTICE Merge branch 'master' into eval_model_unload_fix Apr 1, 2019
README.md Make install instructions shorter. Jul 12, 2019
cloudbuild.yaml Create cloudbuild.yaml Nov 28, 2017
pyproject.toml fixed types and added automatic type checking Jun 12, 2019
requirements-dev.txt Enable more flake8 checks. Jul 30, 2019
requirements-docs.txt update rasabaster dependency Aug 6, 2019
requirements.txt bump to latest t2t Aug 22, 2019
secrets.tar.enc --com Sep 24, 2018
setup.cfg Enable more flake8 checks. Jul 30, 2019
setup.py fix tf 1.14 double logging problem Aug 23, 2019

README.md

Rasa (formerly Rasa Core + Rasa NLU)

Join the chat on Rasa Community Forum PyPI version Supported Python Versions Build Status Coverage Status Documentation Status FOSSA Status PRs Welcome

Rasa is an open source machine learning framework to automate text-and voice-based conversations. With Rasa, you can build chatbots on:

  • Facebook Messenger
  • Slack
  • Microsoft Bot Framework
  • Rocket.Chat
  • Mattermost
  • Telegram
  • Twilio
  • Your own custom conversational channels

or voice assistants as:

  • Alexa Skills
  • Google Home Actions

Rasa's primary purpose is to help you build contextual, layered conversations with lots of back-and-forth. To have a real conversation, you need to have some memory and build on things that were said earlier. Rasa lets you do that in a scalable way.

There's a lot more background information in this blog post.



Where to get help

There is extensive documentation in the Rasa Docs. Make sure to select the correct version so you are looking at the docs for the version you installed.

Please use Rasa Community Forum for quick answers to questions.

README Contents:

How to contribute

We 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:

  1. Create an issue describing the feature you want to work on (or have a look at the contributor board)
  2. Write your code, tests and documentation, and format them with black
  3. Create a pull request describing your changes

Your 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 a Contributor License Agreement.

Development Internals

Running and changing the documentation

To build & edit the docs, first install all necessary dependencies:

pip3 install -r requirements-dev.txt
pip3 install -r requirements-docs.txt

After the installation has finished, you can run and view the documentation locally using:

make livedocs

Visit the local version of the docs at http://localhost:8000 in your browser. You can now change the docs locally and the web page will automatically reload and apply your changes.

Running the Tests

In order to run the tests, make sure that you have the development requirements installed:

export PIP_USE_PEP517=false
pip install -r requirements-dev.txt
pip install -e .
make prepare-tests-ubuntu # Only on Ubuntu
make prepare-tests-macos  # Only on macOS

Then, run the tests:

make test

Steps to release a new version

Releasing a new version is quite simple, as the packages are build and distributed by travis.

Terminology:

  • patch release (third version part increases): 1.1.2 -> 1.1.3
  • minor release (second version part increases): 1.1.3 -> 1.2.0
  • major release (first version part increases): 1.2.0 -> 2.0.0

Release steps:

  1. Create a new branch and
  • Update rasa/version.py to reflect the correct version number
  • Edit the CHANGELOG.rst, create a new section for the release (eg by moving the items from the collected master section) and create a new master logging section
  • Edit the migration guide to provide assistance for users updating to the new version
  1. Commit the changes and create a PR against master or the release branch (e.g. 1.2.x)
  2. Once your PR is merged, tag a new release (this SHOULD always happen on master or release branches), e.g. using
    git tag 1.2.0 -m "Some helpful line describing the release"
    git push origin 1.2.0 --tags
    
    travis will build this tag and push a package to pypi
  3. 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.
    git checkout -b 1.2.x
    git push origin 1.2.x
    

Code Style

To ensure a standardized code style we use the formatter black. To ensure our type annotations are correct we use the type checker pytype. If your code is not formatted properly or doesn't type check, travis will fail to build.

Formatting

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 in 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 via pip install -r requirements-dev.txt. To reformat files execute

make formatter

Type Checking

If you want to check types on the codebase, install pytype using pip install -r requirements-dev.txt. To check the types execute

make types

Deploying documentation updates

We use sphinx-versioning to build docs for tagged versions and for the master branch. The static site that gets built is pushed to the docs branch of this repo, which doesn't contain any code, only the site.

We host the site on netlify. When there is a reason to update the docs (e.g. master has changed or we have tagged a new version) we trigger a webhook on netlify (see .travis.yml).

License

Licensed under the Apache License, Version 2.0. Copyright 2019 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.

You can’t perform that action at this time.