Skip to main content

Async Python SDK for the social-media-automations Instagram Bot API

Project description

social-media-automations (Python SDK)

Async Python client for the Instagram Bot API — register handlers, call run_polling().

Install

pip install -e .

Quickstart

from social_media_automations import Bot

app = Bot(account_key="ak_...")   # your Account Key

@app.on_message()
async def on_dm(msg, ctx):
    await ctx.reply(f"Hi {msg.from_user.username}!")

@app.on_message(text="price")     # case-insensitive substring; or regex="..."
async def price(msg, ctx):
    await ctx.reply("$6/mo")

@app.on_comment()
async def on_comment(c, ctx):
    await ctx.reply_comment("Thanks!")

@app.on_postback(payload="book")  # exact payload; or regex="..."
async def on_btn(pb, ctx):
    await ctx.reply("Let's get you booked!")

app.run_polling()

Handler reference

  • @app.on_message(text=None, regex=None) — DMs. text = case-insensitive substring; regex = re.search; pass at most one.
  • @app.on_comment() — public comments.
  • @app.on_postback(payload=None, regex=None) — button/ice-breaker taps (pb.payload). payload = exact match; regex = re.search; pass at most one.

Handlers are async def handler(obj, ctx). First matching handler wins.

Context (ctx)

  • await ctx.reply(text) — DM the sender.
  • await ctx.reply_comment(text) — public reply (comment handlers only).
  • await ctx.send(to, text) — DM an arbitrary IG-scoped id on this channel.

Notes

  • One channel must be in bot mode first (POST /bot/v1/setDeliveryMode).
  • Polling is at-least-once; msg.id / comment.id are stable for dedup.
  • Ctrl-C stops the bot cleanly.

Project details


Download files

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

Source Distribution

social_media_automations-0.1.0.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

social_media_automations-0.1.0-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file social_media_automations-0.1.0.tar.gz.

File metadata

File hashes

Hashes for social_media_automations-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9336b87e3bd36514bd7df91625579a209f70392b13395f776f80d63c29799e70
MD5 15701e282def7b0b069e4e4c5378f6f6
BLAKE2b-256 9109a44af264930f3a44cdbd4c99cd5767f4443ce1da55ec27ccd7945616b4a7

See more details on using hashes here.

File details

Details for the file social_media_automations-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for social_media_automations-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 49eb4d337c7dac93cb815439b5307ae421589f27e9474050c4f94c5e3215e6b8
MD5 282b574a641dd39d31e2695181f8ad30
BLAKE2b-256 39df22d7728a1dfcdbac5646247140993b91b48802fe565a833a87cea150a89d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page