Skip to main content

Simple framework for building Instagram chat bots with menu driven interface

Project description

instachatbot

CircleCI codecov PyPI version PyPI - Downloads

Simple framework for building Instagram chat bots with menu driven interface

Installation

pip3 install instachatbot

To install development version:

pip3 install git+https://github.com/art-vasilyev/instachatbot.git

How to use

Create sample script main.py:

from instachatbot.bot import InstagramChatBot
from instachatbot.nodes import (
    MenuNode, MenuItem, MessageNode, QuestionnaireNode, NotifyAdminNode)

menu = MenuNode(
    '💡Choose menu:\n',
    [
        MenuItem(
            'text message',
            MessageNode('This is a message😀')),
        MenuItem(
            'questionnaire',
            QuestionnaireNode(
                [
                    'What is your favourite book? 📚',
                    'What is your favourite fruit? 🍐 🍊 🍋'
                ],
                header='Please answer the following questions',
                admin_username='<user to send results to>',
                response='Thank your for your answers')),
        MenuItem(
            'send notification to admin',
            NotifyAdminNode(
                'Thank you',
                notification='Sample notification from bot user',
                admin_username='<username to send notification to>'
            )
        ),
    ],
    error_message='Failed to select menu.'
)

chatbot = InstagramChatBot(menu=menu)
chatbot.login(
    username='<instagram-username>',
    password='<instagram-password>')
chatbot.start()

Run the script:

python3 main.py

Persistent conversation state

By default conversation state is discarded on bot restart, to make it persistent you should provide persistent storage on bot initialization:

chatbot = InstagramChatBot(menu=menu, storage=FileStorage())

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for instachatbot, version 0.3.3
Filename, size File type Python version Upload date Hashes
Filename, size instachatbot-0.3.3-py3-none-any.whl (6.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page