Skip to main content

Official Python library for the Clovord platform.

Project description

clovord

A Python SDK for interacting with the Clovord Gateway and REST API.

Installation

pip install clovord

For local development:

pip install -e .[dev]

Usage

import clovord
import os
from clovord import Bot
import json


intents = clovord.Intents.default()
intents.members = True
intents.messages = True
intents.presence = True

bot = Bot(intents=intents)

@bot.event
async def on_ready():
    print("READY EVENT FIRED")

bot.run(os.environ["BOT_TOKEN"])

Overview

  • Bot is the main entrypoint.
  • The Gateway connection is handled internally with heartbeat and reconnect support.
  • The REST client is asynchronous and available through bot.http.

Extensions (Cogs-like)

clovord.py supports extension modules via setup(bot).

# handlers/message_create.py
def setup(bot):
    @bot.event
    async def on_message_create(message):
        if bot.user and message.author.id == bot.user.id:
            return

        if message.content.startswith("!"):
            await message.channel.send(
                "Hello from extension",
                embeds=[{"title": "Welcome", "description": "Embed support"}],
                container={"type": "card", "accent": "brand"},
            )
from pathlib import Path
from clovord import Bot

bot = Bot()

# Load one importable module
bot.load_extension("mybot.handlers.message_create")

# Load multiple modules
bot.load_extensions(
    "mybot.handlers.message_create",
    "mybot.handlers.ready",
)

# Load all modules from a package (and subpackages)
bot.load_extensions_from_package("mybot.handlers")

# Load all modules from a folder path (and subfolders)
bot.load_extensions_from_path(Path(__file__).parent / "handlers")

Latest Release Notes

Version: 0.1.13dev2 Last commit: fix: update version to 0.1.13dev3 in pyproject.toml

Fixed

  • update version to 0.1.13dev3 in pyproject.toml

See full history in CHANGELOG.md.

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

clovord_py-0.1.13.dev4.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

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

clovord_py-0.1.13.dev4-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file clovord_py-0.1.13.dev4.tar.gz.

File metadata

  • Download URL: clovord_py-0.1.13.dev4.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for clovord_py-0.1.13.dev4.tar.gz
Algorithm Hash digest
SHA256 a2ccfb0be78fe5f64c56fe7d0a6b6042babcd5ae5a2c8902ec81cd7bd31c505d
MD5 fabf0112591ac8bac22ee30520197f47
BLAKE2b-256 a8054f89a2cca9a83fa9b9a8c008882010745c9a62a47be9c28b0cd3104825d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for clovord_py-0.1.13.dev4.tar.gz:

Publisher: release.yml on Clovord/Library---py---clovord.py

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

File details

Details for the file clovord_py-0.1.13.dev4-py3-none-any.whl.

File metadata

File hashes

Hashes for clovord_py-0.1.13.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 c652ada00ab8fb519351bde28d0b3bd33efa63644d92848b14201d10f4814959
MD5 322e6c2d95d91191ad9b318d3173daa6
BLAKE2b-256 6658331650e4207c1020d751b1415d487de2e111ed8bf705a4eb208eaa1a5827

See more details on using hashes here.

Provenance

The following attestation bundles were made for clovord_py-0.1.13.dev4-py3-none-any.whl:

Publisher: release.yml on Clovord/Library---py---clovord.py

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