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(message):
        if message.content.startswith("!"):
            await message.channel.send("Hello from extension")
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.12dev5 Last commit: fix: remove unused on_ready_payload event handler from README

Added

  • add support for extension modules and enhance error handling

Fixed

  • remove unused on_ready_payload event handler from README
  • revert version to 0.1.12 from 0.1.12dev4

Docs

  • update for v0.1.12dev4

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: clovord_py-0.1.13.dev1.tar.gz
  • Upload date:
  • Size: 19.1 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.dev1.tar.gz
Algorithm Hash digest
SHA256 bdaf3c924c2fe1efe830543eb3cfb126fc01111e9300413ef75e6c353f4c203c
MD5 387eec1fe0a8256d25ce371b3ea4a763
BLAKE2b-256 900482e3dc6fa94277eaa794fecc6b0fac62d8f56ae9d0e10184c1ff9ac55baa

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for clovord_py-0.1.13.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 3aec998b1697ec2da68fe3fe97d6d0bd2c32acc484928702e541b51dfff9def3
MD5 e88bf7afffaa5417f794929f45d6af89
BLAKE2b-256 a22a219f019ca91059d5ca51c98dd6d77ab8bf10f2c8c978a8b30f8d747c7030

See more details on using hashes here.

Provenance

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