Metadata-Version: 2.0
Name: pengbot
Version: 0.1a1
Summary: A Bot framework to build bots with human manners
Home-page: https://github.com/mariocesar/pengbot
Author: Mario César Señoranis Ayala
Author-email: mariocesar.c50@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Development Status :: 2 - Pre-Alpha

Pengbot: For building robots with human manners
===============================================

**warning:** Pengbo is currently in DESIGN

.. code-block:: python

    import pengbot
    from pengbot.adapters import SlackRobot, Mention

    @pengbot.make_robot(SlackRobot)
    def mybot(bot):
        bot.context = bot.context(
            api_token=os.environ.get('SLACK_API_TOKEN', None)
        )

    @vvbot.hears(Mention)
    def talking_parrot(bot, message):
        yield from bot.says(':bird: %s' % message['text'] , channel=message['channel'])

    if __name__ == '__main__':
        mybot()

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

.. code-block:: bash

    $ pip install pengbot

Documentation
-------------

.. TODO


TODO
----

    - Fuzzy string match for commands
    - Commands receive message context.
    - Listen all messages to trigger commands.
    - Adapters for Slack, XMPP, Twitter.
    - Message stream filters.
    - Message stream middlewares.
    - Stream response messages.
    - Natural Language Processing?. http://spacy.io

Example ideas
-------------

    - Auto linking for Jira Issues.
    - Attach user mentions to issues as comments in Jira.
    - Bots talking to bots.
    - Voting and Polls.


