ChatterBot 0.2.3

An open-source chat bot program written in Python.

.. figure:: http://i.imgur.com/b3SCmGT.png
:alt: Chatterbot: Machine learning in Python

Chatterbot: Machine learning in Python
ChatterBot
==========

ChatterBot is a machine-learning based conversational dialog engine
build in Python which makes it possible to generate responses based on
collections of known conversations. The language independent design of
ChatterBot allows it to be trained to speak any language.

|Package Version| |Requirements Status| |Build Status| |Coverage Status|
|Code Climate|

An example of typical input would be something like this:

| **user:** Good morning! How are you doing?
| **bot:** I am doing very well, thank you for asking.
| **user:** You're welcome.
| **bot:** Do you like hats?

How it works
------------

An untrained instance of ChatterBot starts off with no knowledge of how
to communicate. Each time a user enters a statement, the library saves
the text that they entered and the text that the statement was in
response to. As ChatterBot receives more input the number of responses
that it can reply and the accuracy of each response in relation to the
input statement increase. The program selects the closest matching
response by searching for the closest matching known statement that
matches the input, it then returns the most likely response to that
statement based on how frequently each response is issued by the people
the bot communicates with.

Installation
------------

This package can be installed from
`PyPi <https://pypi.python.org/pypi/ChatterBot>`__ by running:

::

pip install chatterbot

Basic Usage
-----------

::

from chatterbot import ChatBot
chatbot = ChatBot("Ron Obvious")

chatbot.get_response("Hello, how are you today?")

Documentation
=============

View the
`documentation <https://github.com/gunthercox/ChatterBot/wiki/Quick-Start>`__
for using ChatterBot in the project wiki.

Examples
========

For examples, see the
`examples <https://github.com/gunthercox/ChatterBot/tree/master/examples>`__
directory in this project's repository.

There is also an example `Django project using
ChatterBot <https://github.com/gunthercox/django_chatterbot>`__.

Testing
=======

| ChatterBot's built in tests can be run using nose.
| See the `nose
documentation <https://nose.readthedocs.org/en/latest/>`__ for more
information.

Applications
============

Have you created something cool using ChatterBot? Please add your
creation to the `list of
projects <https://github.com/gunthercox/ChatterBot/wiki/ChatterBot-Showcase>`__
using ChatterBot in the wiki.

History
=======

See release notes for changes
https://github.com/gunthercox/ChatterBot/releases

.. |Package Version| image:: https://badge.fury.io/py/ChatterBot.png
:target: http://badge.fury.io/py/ChatterBot
.. |Requirements Status| image:: https://requires.io/github/gunthercox/ChatterBot/requirements.svg?branch=master
:target: https://requires.io/github/gunthercox/ChatterBot/requirements/?branch=master
.. |Build Status| image:: https://travis-ci.org/gunthercox/ChatterBot.svg?branch=master
:target: https://travis-ci.org/gunthercox/ChatterBot
.. |Coverage Status| image:: https://img.shields.io/coveralls/gunthercox/ChatterBot.svg
:target: https://coveralls.io/r/gunthercox/ChatterBot
.. |Code Climate| image:: https://codeclimate.com/github/gunthercox/ChatterBot/badges/gpa.svg
:target: https://codeclimate.com/github/gunthercox/ChatterBot