Skip to main content

Lightweight library for building Microsoft Bot Service bots - Python

Project description

botas logo

botas

A lightweight, multi-language library for building Microsoft Teams bots — this is the core Python package.

For zero-boilerplate FastAPI hosting, see botas-fastapi.

Installation

pip install botas

Quick start (with FastAPI)

from botas import BotApplication
from botas_fastapi import bot_auth_dependency
from fastapi import Depends, FastAPI, Request

bot = BotApplication()

@bot.on("message")
async def on_message(ctx):
    await ctx.send(f"You said: {ctx.activity.text}")

app = FastAPI()

@app.post("/api/messages", dependencies=[Depends(bot_auth_dependency())])
async def messages(request: Request):
    body = await request.body()
    await bot.process_body(body.decode())
    return {}

Or use the higher-level botas-fastapi wrapper for a simpler setup:

from botas_fastapi import BotApp

app = BotApp()

@app.on("message")
async def on_message(ctx):
    await ctx.send(f"You said: {ctx.activity.text}")

app.start()

API

BotApplication

The core bot class — web-framework-agnostic.

Method Description
on(type, handler) Register a handler for an activity type (also works as a @decorator)
on_invoke(name, handler) Register a handler for an invoke activity by name (also works as a @decorator)
use(middleware) Add a middleware to the turn pipeline (runs in registration order)
process_body(body) Process a raw JSON body string

Authentication options

BotApplicationOptions fields (also resolved from environment variables):

Option Env variable Description
client_id CLIENT_ID Azure AD application (bot) ID
client_secret CLIENT_SECRET Azure AD client secret
tenant_id TENANT_ID Azure AD tenant ID (default: common)
managed_identity_client_id MANAGED_IDENTITY_CLIENT_ID Managed identity client ID
token_factory Custom async token factory (scope, tenant_id) -> str

Documentation

License

MIT

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

botas-0.3.33.tar.gz (29.6 kB view details)

Uploaded Source

Built Distribution

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

botas-0.3.33-py3-none-any.whl (26.5 kB view details)

Uploaded Python 3

File details

Details for the file botas-0.3.33.tar.gz.

File metadata

  • Download URL: botas-0.3.33.tar.gz
  • Upload date:
  • Size: 29.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for botas-0.3.33.tar.gz
Algorithm Hash digest
SHA256 52601175f897359962704fcb5720b230071f8eadf9491e5d7f4876662b55f8ce
MD5 8382cd03a8000e2d41ab7faeaed31c25
BLAKE2b-256 4eab3a2b216dd2ce4c7137dc59f30d4d119c4e4f2a26192e516fc8f82ff15357

See more details on using hashes here.

Provenance

The following attestation bundles were made for botas-0.3.33.tar.gz:

Publisher: CD.yml on rido-min/botas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file botas-0.3.33-py3-none-any.whl.

File metadata

  • Download URL: botas-0.3.33-py3-none-any.whl
  • Upload date:
  • Size: 26.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for botas-0.3.33-py3-none-any.whl
Algorithm Hash digest
SHA256 3b22c0fea671f9ebdcbeb8a26c29e5d92054c7c7d914c12c716015baff8e9cc0
MD5 78ad77bcd984f25c83d52956b75a99e0
BLAKE2b-256 1e795352ff04010ca0a142e816d1b562693a4f92d96e02039c4e39f54286c7dc

See more details on using hashes here.

Provenance

The following attestation bundles were made for botas-0.3.33-py3-none-any.whl:

Publisher: CD.yml on rido-min/botas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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