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.69.tar.gz (30.9 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.69-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: botas-0.3.69.tar.gz
  • Upload date:
  • Size: 30.9 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.69.tar.gz
Algorithm Hash digest
SHA256 bc8f9a18547e68dfa9c523234fac1f39d90017002b761f3fc8ddfb0c209fb58c
MD5 ec661dbcb6b5489620988aea8264983f
BLAKE2b-256 fc038e1e7d58cd579519b7dda96b106a3e7c48787adffbaed6cca01a1e06bd7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for botas-0.3.69.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.69-py3-none-any.whl.

File metadata

  • Download URL: botas-0.3.69-py3-none-any.whl
  • Upload date:
  • Size: 26.9 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.69-py3-none-any.whl
Algorithm Hash digest
SHA256 c3bab6f613892c2eca7e6b83d3515185f5697dabf9ee20776c5375a677e6dbde
MD5 a97ce37ce23efa5e79f93258bdf29884
BLAKE2b-256 2ed6a4a886074bb826a0c0569993c357dff36052e49affa602cbe0e401fbc888

See more details on using hashes here.

Provenance

The following attestation bundles were made for botas-0.3.69-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