osmium-chat

A Python API wrapper for Osmium.

enbyware

[!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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osmium_chat-0.3.6.tar.gz (40.0 kB view details)

Uploaded Jun 15, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

osmium_chat-0.3.6-py3-none-any.whl (52.4 kB view details)

Uploaded Jun 15, 2026 Python 3

File details

Details for the file osmium_chat-0.3.6.tar.gz.

File metadata

Download URL: osmium_chat-0.3.6.tar.gz
Upload date: Jun 15, 2026
Size: 40.0 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for osmium_chat-0.3.6.tar.gz
Algorithm	Hash digest
SHA256	`0314eab30015b55b90a7d9c99ef4bd248d56164cd22ec37fe69583a1a17737cf`
MD5	`277eca2ed56c0c5e53dce037f9a63184`
BLAKE2b-256	`49d53bf8bb1e07a4caf6cf1ee6477c927f3464ba1972f5e06bfa87e7942cc1a8`

See more details on using hashes here.

Provenance

The following attestation bundles were made for osmium_chat-0.3.6.tar.gz:

Publisher: ci-cd.yml on ijsbol/osmium-chat

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: osmium_chat-0.3.6.tar.gz
- Subject digest: 0314eab30015b55b90a7d9c99ef4bd248d56164cd22ec37fe69583a1a17737cf
- Sigstore transparency entry: 1825986479
- Sigstore integration time: Jun 15, 2026
Source repository:
- Permalink: ijsbol/osmium-chat@4a5658c6590c052abcf3738162f32bfc67aa6eb3
- Branch / Tag: refs/tags/v0.3.6
- Owner: https://github.com/ijsbol
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: ci-cd.yml@4a5658c6590c052abcf3738162f32bfc67aa6eb3
- Trigger Event: release