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

Added

  • update version to 0.1.12dev4 and enhance logger setup

Docs

  • update for v0.1.12dev3

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: clovord_py-0.1.12.tar.gz
  • Upload date:
  • Size: 19.0 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.12.tar.gz
Algorithm Hash digest
SHA256 e3c7891f18e2a18cd421cf8730d038f43f813aba11b8d1dcb0e145cc76d20058
MD5 e14bae246027e6ec23916e0c774af98d
BLAKE2b-256 886862a26572dbae7413d10a9e16c08776b6a0552cdcec4fdfd3e77445052204

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: clovord_py-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 20.4 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 c464ca044038a2811ec78a573bf45d66684a900299eea65bf2cbd7e0d0086630
MD5 86bbd7ddb402f0b2d1be125c7bf62213
BLAKE2b-256 d1da7386e5ab34e65571266f7d2dd419ed14f0939a8737acc0e4e32959dbda33

See more details on using hashes here.

Provenance

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