Metadata-Version: 2.0
Name: ChatterBot
Version: 0.0.2
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,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
==========

This is a chat bot program that takes input and returns a response based
on known conversations.

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

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

This package can be installed using

::

    pip install chatterbot

Useage
------

Create a new chat bot

::

    from chatterbot import ChatBot
    chatbot = ChatBot()

Specify a defult location for engram memory files

::

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

Getting an engram based response

::

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

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

Requirements
------------

To install required packages for this project run the command: *(This is
only required when not installing through pip)*

::

    sudo pip install -r requirements.txt

A general warning
-----------------

This program is capable of retrieving conversation data from various
social networks in order to provide more accurate replies to input text.
Because of this, responces generated by the chat bot can contain
insulting statements completely at random. I have plans to address this
issue, however they are not yet implemented.

Notes
-----

This program is not designed to be an open source version of CleverBot.
Although this **Chat Bot** returns responces, the code here handles
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/d/ChatterBot/badge.png
   :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
-------

0.0.0 (2014-10-11)
---------------------

* First release on PyPI.

0.0.1 (2014-10-14)
---------------------

* Updated documentation.

0.0.2 (2014-10-15)
---------------------

* Changed package name to lowercase format.
* Tests now create sample log files.


