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 — all bot-mode channels

# ...or scope updates to specific channels (server-side filter):
app = Bot(account_key="ak_...", channel_ids=["ch-1", "ch-2"])

@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.5.tar.gz (27.3 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.5-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for social_media_automations-0.1.5.tar.gz
Algorithm Hash digest
SHA256 5e6a257d5b7dbb3873ee234491defe26d58380c1bc94d974e2f102126ff573db
MD5 479980fdc1569d74563dadcb15dfc7a9
BLAKE2b-256 e39e9b5ddf2b0db48706335eb8e91a40cefe63370548c32d82212af926f76ff3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for social_media_automations-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 262e9874cf80f219c587e06b730301c157fe818ef9256ade8caa7194cf919fd2
MD5 6227840d34e0ddf6ae7e5c11ce8a3d6e
BLAKE2b-256 1ef13b468ae0ef49b6d3f76831322bccf3c933429d1d99f7068769dde403ec8b

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