Metadata-Version: 2.1
Name: cleverbotfree
Version: 1.2.5
Summary: Free Alternative For The Cleverbot API
Home-page: http://github.com/plasticuproject/cleverbotfree
Author: plasticuproject
Author-email: plasticuproject@pm.me
License: GPLv3
Download-URL: https://github.com/plasticuproject/cleverbotfree/archive/v1.2.5.tar.gz
Description: [![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html)
        [![PyPI version](https://badge.fury.io/py/cleverbotfree.svg)](https://badge.fury.io/py/cleverbotfree)
        [![Downloads](https://pepy.tech/badge/cleverbotfree)](https://pepy.tech/project/cleverbotfree)
        # cleverbotfree
        Cleverbot.com used to have a free API for their chatbot application. They have <br />
        removed their free API in place of a tiered subscription API service. <br />
        cleverbotfree is a free alternative to that API that uses a headless Firefox <br />
        browser to communicate with their chatbot application. You can use this module <br />
        to create applications/bots that send and receive messages to the Cleverbot <br />
        chatbot application <br />
        
        
        ## Installation
        <b>Requirments</b>
        
        You need to have Python 3.x, pip, and the latest Firefox browser installed. <br />
        Once installed, you can install this library through pip. <br />
        ```
        pip install cleverbotfree
        ```
        
        <b>Drivers</b>
        
        Selenium requires a driver to interface with the headless browser. Firefox <br />
        requires geckodriver, which needs to be installed before this module can be <br />
        used. Make sure it’s in your PATH, e. g., place it in /usr/bin or /usr/local/bin. <br />
        
        You can download the geckodriver at https://github.com/mozilla/geckodriver/releases <br />
        
        Failure to observe this step will give you the error <br />
        "Message: ‘geckodriver’ executable needs to be in PATH." <br />
        
        
        ## Usage
        <b>Examples</b>
        
        Example of a simple CLI script that creates a single use, one message chat session. <br />
        ```python
        import cleverbotfree.cbfree
        import sys
        cb = cleverbotfree.cbfree.Cleverbot()
        
        def chat():
            userInput = input('User: ')
            response = cb.single_exchange(userInput)
            print(response)
            cb.browser.close()
            sys.exit()
        
        chat()
        ```
        
        Example of a simple CLI script that creates a persistent chat session untill closed. <br />
        ```python
        import cleverbotfree.cbfree
        import sys
        cb = cleverbotfree.cbfree.Cleverbot()
        
        def chat():
            try:
                cb.browser.get(cb.url)
            except:
                cb.browser.close()
                sys.exit()
            while True:
                try:
                    cb.get_form()
                except:
                    sys.exit()
                userInput = input('User: ')
                if userInput == 'quit':
                    break
                cb.send_input(userInput)
                bot = cb.get_response()
                print('Cleverbot: ', bot)
            cb.browser.close()
        
        chat()
        ```
        
Keywords: cleverbot,bot,api,free
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
