Metadata-Version: 1.0
Name: pyElizaChatbotClient
Version: 0.1.6
Summary: Basic stand-alone/websocket client for using in the Re-WoChat Shared task.
Home-page: http://workshop.colips.org/re-wochat/
Author: Luis Fernando D'Haro
Author-email: luisdhe@i2r.a-star.edu.sg
License: LICENSE.txt
Description: ======================
        Eliza Chatbot Client
        ======================
        
        This package is released in the context of Re-WoChat: Workshop on Collecting
        and Generating Resources for Chatbots and Conversational Agents - Development
        and Evaluation as part of the shared task.
        
           link: http://workshop.colips.org/re-wochat/shared.html
        
        The goal of the shared task is to collect data and annotations from
        human-machine and human-human dialogues annotated by the participants.
        Human-machine dialogues will be generated by using different online
        and offline chat engines, and annotations are to be generated following a
        provided set of guidelines. The collected dataset will be made publicly
        available to the research community for further research and experimentation
        in future editions of the workshop.
        
        In this context, the organizing committee releases this chatbot which works
        as a stand-alone application and generates a log file with the interactions
        with the users. The generated log is finally converted into a XML file that,
        participants must submit, together with the log file, to the organizers.
        
        
        Installation
        =========
        
        There are several options to install this program; the simplest one is to run
        from a command line the following instruction (for Linux):
        
         > pip install pyElizaChatbotClient --upgrade
        
        This will download the program from http://pypy.org together with all the
        required packages.
        
        If you want to do a manual installation, then you can do:
        
         > pip install pyElizaChatbotClient-[VERSION]-py2.py3-none-any.whl
        
        Or if you want to do it from the source files, then you will need to do:
        
        > tar -xvzf pyElizaChatbotClient-[VERSION].tar.gz
        > cd pyElizaChatbotClient-[VERSION]
        > python setup.py install
        
        
        For Windows users, the easiest way is to run (replace the path with the one
        in your current Python installation):
        
        > C:\Python2.7\Scripts\pip.exe pyElizaChatbotClient --upgrade
        
        
        This program has been tested using Python 2.7.6 and Python 3.4.3 on Ubuntu Linux and Windows 7
        
        
        Usage
        =========
        
        Typical usage as stand-alone application will be:
        
            > python -m pyElizaChatbotClient
        
        or
            > python test/pyElizaChatbotClient.py
        
        Alternatively, you can use it from another python program using:
        
               from pyElizaChatbotClient.pyEliza import pyElizaChatbot
               client = pyElizaChatbot(name='Eliza', log_file='pyEliza.log')
               client.start()
        
Keywords: chatbots eliza re-wochat shared-task
Platform: UNKNOWN
