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.3.tar.gz (26.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.3-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for social_media_automations-0.1.3.tar.gz
Algorithm Hash digest
SHA256 8ac5aff71845de38a203d2fc36eebfe27381567da030c152d71bd8aa85232f1b
MD5 d3500affdfb0c95d99aa2e5e12f66a85
BLAKE2b-256 9f0a9d3721c69128da22867e0c8b35fcb7a5fb0e145f466211358a29b39d4421

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for social_media_automations-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 31ac2632e562f6cd8374252628fd8dafcb8d79b7ed024d4ccab27e98482846da
MD5 c6734b8be61ac556718f1324e18cb647
BLAKE2b-256 ebc4504dbcfdab1a60ee8a1869a31d27ef74000f5e91ee6efa209f61b9d57655

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