osmium-chat 0.3.1

A Python API wrapper for Osmium.

osmium-chat

A Python API wrapper for Osmium.

[!NOTE] the documentation was ai-assisted as i suck at writing documentation lol

---

Installation

pip install osmium-chat

Requires Python 3.13+.

---

Quick start

from osmium_chat import Bot, Context
from osmium_chat.commands import CommandRestriction

bot = Bot(prefix="!", client_id=YOUR_CLIENT_ID)


@bot.on("connect")
async def on_connect() -> None:
    print("Connected!")


@bot.command("ping")
async def ping(ctx: Context) -> None:
    await ctx.channel.send("Pong!")


@bot.command("say", restriction=CommandRestriction.COMMUNITY_ONLY)
async def say(ctx: Context, *, words: str) -> None:
    await ctx.channel.send(words)


bot.run(token="YOUR_TOKEN")

---

Rich text formatting

from osmium_chat.content import Bold, CodeBlock, Content, Italic, Spoiler, TextUrl

await ctx.channel.send(Content(
    f"Hello, {Bold('world')}! ",
    TextUrl("osmium.chat", url="https://osmium.chat"),
))

---

Features

• Commands — prefix-based command routing with automatic argument parsing and type conversion
• Command restrictions — CommandRestriction.NONE (default), DM_ONLY, or COMMUNITY_ONLY
• Rich text — Bold, Italic, Underline, Code, CodeBlock, Spoiler, TextUrl, and more
• Communities — create/manage channels, categories, and roles
• Invites — create, list, look up, and revoke invite links
• File attachments — upload files from bytes, download and save attachments to disk
• Events — connect, message, guild_message, dm_message, command_error

---

Documentation

Full API reference: osmium-chat.readthedocs.io

More examples in the examples/ directory.

---

Links

• GitHub
• Bug tracker
• PyPI
• Osmium