Skip to main content

A front-end framework for discord.py

Project description

blurple.py

A front-end framework for discord.py

PyPI License Stars

Blurple.py is a framework built on top of discord.py, giving you the tools you need to build discord bots with convenience.

Here's what's included:

  1. blurple.ui All the styled components you'll ever need for building user interfaces in discord.
    • Planned support for modals and more in the future, using discord's new api.
  2. blurple.io Robust functions that enable you to build stable, multi-step commands with ease.
    • Support for multi-event replies, and timeout handling by default.
  3. blurple.ext Utilities and sane defaults for discord.ext commands.
    • An unopinionated drop-in replacement for the builtin help command.
    • A minimal, route-based microframework for registering commands.

Usage

Documentation can be found here.

Installation

  1. Make sure your python version is up-to-date.
  2. Install the package with pip install blurple.py.

Example with blurple.ui

  import discord
  from discord.ext import commands
+ from blurple import ui

  bot = commands.Bot(command_prefix='!')

  @bot.command()
  async def ping(ctx):
-     await ctx.send('Pong!')
+     await ctx.send(embed=ui.Alert(ui.Style.SUCCESS,
+         title="Pong!",
+         description=f"Latency: `{round(bot.latency*1000)}ms`")
+     )

  bot.run('token')

Usage

Running locally

  1. Clone the repository git clone https://github.com/LeptoFlare/blurple.py.git
  2. Create a .env in the repository root with your token: TOKEN=kpXVCJ9.pLY.Q6m9F
  3. The repo contains a test.py file used for testing, simply run the file python3 test.py

Contact me · @LeptoFlare · lepto.tech

As always, distributed under the MIT license. See LICENSE for more information.

https://github.com/LeptoFlare/blurple.py

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

blurple.py-0.5.3.tar.gz (13.1 kB view hashes)

Uploaded Source

Built Distribution

blurple.py-0.5.3-py3-none-any.whl (15.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page