Skip to main content

An open-source chat bot program written in Python.

Project description

ChatterBot
==========

This library allows developers to create language independent chat bots
that return responses to based on collections of known conversations.

|Package Version| |Build Status| |PyPi| |Coverage Status|

| 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: Your welcome.
| > bot: Do you like hats?

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

This package can be installed using

::

pip install chatterbot

Useage
------

| Create a new chat bot
| **Note:** This object takes an optional parameter for the bot's name.

::

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

Getting a response to input text

::

response = chatbot.get_response("Good morning!")
print(response)

| Specify a defult location for conversation log files
| **Note:** The default log directory is ``conversation_engrams/``.

::

chatbot.log_directory = "path/to/directory/"

Terminal mode (User and chat bot)

::

from chatterbot import Terminal
terminal = Terminal()
terminal.begin()

Have the chat bot talk with CleverBot

::

from chatterbot import TalkWithCleverbot
talk = TalkWithCleverbot()
talk.begin()

Notes
-----

Sample conversations for training the chatbot can be downloaded from
https://gist.github.com/gunthercox/6bde8279615b9b638f71

This program is not designed to be an open source version of CleverBot.
Although this **Chat Bot** returns responces, the code here handels
communication much differently then
`CleverBot <http://www.cleverbot.com>`__ does.

.. |Package Version| image:: https://badge.fury.io/py/ChatterBot.png
:target: http://badge.fury.io/py/ChatterBot
.. |Build Status| image:: https://travis-ci.org/gunthercox/ChatterBot.svg?branch=master
:target: https://travis-ci.org/gunthercox/ChatterBot
.. |PyPi| image:: https://pypip.in/download/ChatterBot/badge.svg
:target: https://pypi.python.org/pypi/ChatterBot
.. |Coverage Status| image:: https://img.shields.io/coveralls/gunthercox/ChatterBot.svg
:target: https://coveralls.io/r/gunthercox/ChatterBot




History
-------

`See release notes
<https://github.com/gunthercox/ChatterBot/releases>`_

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

ChatterBot-0.0.3.tar.gz (20.2 kB view hashes)

Uploaded Source

Built Distribution

ChatterBot-0.0.3-py2.py3-none-any.whl (15.2 kB view hashes)

Uploaded Python 2 Python 3

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