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.13dev4 Last commit: Merge branch 'main' of https://github.com/Clovord/Library---py---clovord.py

Fixed

  • update version to 0.1.13dev4 in pyproject.toml and enhance message handling in message_create.py

Docs

  • update for v0.1.13dev2

Other

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: clovord_py-0.1.13.tar.gz
  • Upload date:
  • Size: 19.7 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.tar.gz
Algorithm Hash digest
SHA256 62c99d019cdee79ee6ca87085c8b41033d5df06e0ad3a4f7c9cdaa7f42e9bf41
MD5 8589656dca17e250b3f58a1a4791d5b2
BLAKE2b-256 7900a8e0b1341abf6c61b6c352c998fed0ffe7aa52aedba57478e1957ee6af58

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: clovord_py-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for clovord_py-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 227a768e74e44e5d430f7e01bea910fdefb7a2b2a4bc21b1c327e6257df2968b
MD5 2c6b6a379f0d6923727caa521ab01a82
BLAKE2b-256 1f33a2372f77a2fc7a9a87d97a73d10a84f81dd01aecfc60bcf607e339dd0fad

See more details on using hashes here.

Provenance

The following attestation bundles were made for clovord_py-0.1.13-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