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 social-media-automations

For local development from a clone: pip install -e ".[dev]"

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.2.tar.gz (24.4 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.2-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for social_media_automations-0.1.2.tar.gz
Algorithm Hash digest
SHA256 a7399a67bb63c05a12a9edf986aade9be4a0b90f79bac5e71c379b5580a313b2
MD5 dd5b0c8672ae5d8eb7c6bc0c5e717764
BLAKE2b-256 7c8650de8e0017a13108997d9bcafcfa7d0ad849638a5cd9596f3149d0962fc7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for social_media_automations-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f10ffdadffb01d3acaafbd7743fa04ed8173f5176f28bc7dc78f589f0893a3e8
MD5 9abc93f0a29a9927339c994223915857
BLAKE2b-256 4272e3725cc918cf5afb82ed1769d09cc47952221b452fc2eb6de38710736a48

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