Skip to main content

Machine learning based dialogue engine for conversational software.

Project description

Rasa Core
=========

|Join the chat at https://gitter.im/RasaHQ/rasa\_core| |Build Status|
|Coverage Status| |PyPI version|

`Go To Docs <https://core.rasa.ai>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Introduction
------------

Rasa Core is a framework for building conversational software, which
includes: - chatbots on Messenger - Slack bots - Alexa Skills - Google
Home Actions

etc.

Rasa Core'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 Core lets you do that in a scalable way.

There's a lot more background information in this `blog
post <https://medium.com/rasa-blog/a-new-approach-to-conversational-software-2e64a5d05f2a>`__

Where to get help
-----------------

There is extensive documentation:

- `master <https://core.rasa.ai/master/>`__  (if you install from
**github**) or
- `stable <https://core.rasa.ai/>`__   (if you install from **pypi**)

Please use `gitter <https://gitter.im/RasaHQ/rasa_core>`__ for quick
answers to questions.

README Contents:
^^^^^^^^^^^^^^^^

- `Setup <#setup>`__
- `How to contribute <#how-to-contribute>`__
- `Development Internals <#development-internals>`__
- `License <#license>`__

Setup
-----

There isn't a released pypi package yet. Hence, you need to clone and
install the package from the github repository. For a more detailed
description, please visit the `**Installation
page** <https://core.rasa.ai/installation.html>`__ of the docs.

To install, run:

.. code:: bash

git clone https://github.com/RasaHQ/rasa_core.git
cd rasa_core
pip install -r requirements.txt
pip install -e .

Development Internals
---------------------

Running and changing the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

::

brew install sphinx
pip install -r dev-requirements.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.

License
-------

Licensed under the Apache License, Version 2.0. Copyright 2017 Rasa
Technologies GmbH. `Copy of the license <LICENSE.txt>`__.

.. |Join the chat at https://gitter.im/RasaHQ/rasa\_core| image:: https://badges.gitter.im/Join%20Chat.svg
:target: https://gitter.im/RasaHQ/rasa_core?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |Build Status| image:: https://travis-ci.org/RasaHQ/rasa_core.svg?branch=master
:target: https://travis-ci.org/RasaHQ/rasa_core
.. |Coverage Status| image:: https://coveralls.io/repos/github/RasaHQ/rasa_core/badge.svg?branch=master
:target: https://coveralls.io/github/RasaHQ/rasa_core?branch=master
.. |PyPI version| image:: https://badge.fury.io/py/rasa_core.svg
:target: https://badge.fury.io/py/rasa_core

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rasa_core-0.7.0a9.tar.gz (60.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page