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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mycord-1.0.5.tar.gz
Algorithm Hash digest
SHA256 ac7a88dff2c326037b2289ab955d90500d96a1f415a159ab6b91a70942addcbc
MD5 886ee250446536752c71f11a5eeec754
BLAKE2b-256 128aa989564b94c23c6b3c02ffe80b8f78e5666bcbb8b9366a21d523e015c49b

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: mycord-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 5.0 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.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fd25488069b73ad4e81dd5e3f77901164116fa873c82bde83f15a70b92b2ecef
MD5 cd0889f0d9df20e890bb72cbc6fa001b
BLAKE2b-256 8157dbc544348eeae42d06fa77a091c1137bbb1ac334041b5c7a64829e56769d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mycord-1.0.5-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