Skip to main content

A minimalist Discord bot framework that communicates directly with Discord Gateway and REST.

Project description

mycord

A minimalist Discord bot wrapper around discord.py.

mycord is designed for beginners:

  • One import: import mycord
  • Simple bot startup with bot.start()
  • Automatic .env loading for TOKEN
  • Built-in bot.db helper for SQLite
  • Lightweight wrapper over discord.py commands and events

Installation

pip install mycord

From source

git clone https://github.com/amri4/mycord.git
cd mycord
pip install -e .

Quick Start

Create a .env file in the same folder as main.py:

TOKEN=your_discord_bot_token_here

Create main.py:

import mycord

bot = mycord.Bot(prefix="!")

@bot.event
async def on_ready():
    print("✅ Bot online")

@bot.command(name="ping")
async def ping(ctx):
    await ctx.send("Pong!")

bot.start()

Run:

python main.py

mycord.Bot

bot = mycord.Bot(prefix="!", db_name="mycord_data.db")

The main bot class. It is a lightweight wrapper around discord.py that exposes commands, events, and database helpers.

Parameters

Parameter Type Default Description
prefix str "!" Command prefix
token str None Discord bot token; if omitted, TOKEN is loaded from .env or environment
db_name str "mycord_data.db" SQLite filename

Methods

bot.start(token=None)

Start the bot. If token is omitted, mycord loads TOKEN automatically.

bot.start()

bot.run_bot(token_env_name="TOKEN")

Alias for bot.start() that reads the token from an environment variable name.

bot.run_bot()

bot.get_env(key, default=None)

Read any environment variable.

token = bot.get_env("TOKEN")

Events and Commands

Events

Use @bot.event to register event handlers.

@bot.event
async def on_ready():
    print("Bot online")

@bot.event
async def on_message(ctx):
    print(ctx.content)

Commands

Use @bot.command(name="...") to register commands.

@bot.command(name="hello")
async def hello(ctx):
    await ctx.send("Hello!")

Database Helpers

mycord includes a lightweight SQLite wrapper available as bot.db.

bot.create_table("users", "id INTEGER PRIMARY KEY, name TEXT")

Common methods available on bot and bot.db:

  • create_table(name, columns)
  • insert(table, columns, values)
  • insert_replace(table, columns, values)
  • fetchone(table, condition=None, values=())
  • fetchall(table)
  • update(table, set_values, condition, values)
  • delete(table, condition, values)
  • exists(table, condition, values)

Utilities

mycord.Tools

if mycord.Tools.chance(25):
    print("1 in 4 chance")

print(mycord.Tools.timestamp())

mycord.os

A shortcut to Python's standard os module.

prefix = mycord.os.getenv("PREFIX", "!")

Example: Bot with Database

import mycord

bot = mycord.Bot()

@bot.event
async def on_ready():
    bot.create_table("points", "user_id INTEGER PRIMARY KEY, amount INTEGER DEFAULT 0")

@bot.command(name="points")
async def points(ctx):
    row = bot.fetchone("points", "user_id = ?", (ctx.author.id,))
    total = row[1] if row else 0
    await ctx.send(f"Points: {total}")

bot.start()

Requirements

  • Python >=3.8
  • discord.py>=2.0.0
  • python-dotenv>=1.0.0

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

mycord-1.1.1.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

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

mycord-1.1.1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file mycord-1.1.1.tar.gz.

File metadata

  • Download URL: mycord-1.1.1.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mycord-1.1.1.tar.gz
Algorithm Hash digest
SHA256 4c03052564eab7c751dd40a44482e41b59ea8685bc24ecab2b1ce8866c520186
MD5 47901e75a5307af4c71b41fdf9bce19a
BLAKE2b-256 ab7760f05a670d0a4528edaa2fd2f16068b1326c37cef589e77f478c97936170

See more details on using hashes here.

Provenance

The following attestation bundles were made for mycord-1.1.1.tar.gz:

Publisher: publish.yml on amri4/mycord

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

File details

Details for the file mycord-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: mycord-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mycord-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a9ca5a1863c0685d3669d436185227a12a10dff1b1cc6b53141f929119307397
MD5 c2cc1e5d34e5f2b868add2f5aa87372c
BLAKE2b-256 ed735727e1a1faf19a26f388e580c05340ad544081c7f311c5aa96c90aee3991

See more details on using hashes here.

Provenance

The following attestation bundles were made for mycord-1.1.1-py3-none-any.whl:

Publisher: publish.yml on amri4/mycord

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