Metadata-Version: 2.0
Name: ChatterBot
Version: 0.0.4
Summary: An open-source chat bot program written in Python.
Home-page: https://github.com/gunthercox/ChatterBot
Author: Gunther Cox
Author-email: gunthercx@gmail.com
License: BSD
Keywords: ChatterBot,chatbot,chat,bot
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: fuzzywuzzy (==0.3.2)

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

Usage
-----

| 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 default 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()

**Social mode (Have the bot respond to users on social media sites)**

::

    from chatterbot import SocialBot

    log_dir = "path/to/conversation_engrams/"

    TWITTER = {
        "CONSUMER_KEY": "<consumer_key>",
        "CONSUMER_SECRET": "<consumer_secret>"
    }

    chatbot = SocialBot(log_directory=log_dir, twitter=TWITTER)

You will need to generate your own keys for using any API. To use this
feature you will need to register your application at `Twitter's
developer website <https://dev.twitter.com/apps>`__ to get the token and
secret keys.

Use Cases
---------

**Using ChatterBot in your app? Let us know!** - `Salvius (humanoid
robot) <https://github.com/gunthercox/salvius>`__

Notes
-----

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

.. |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>`_


