Pincer

An asynchronous Python API wrapper meant to replace discord.py

❗	The package is currently within Pre-Alpha phase

📌 Links

｜Join the Discord server: https://discord.gg/pincer
｜The PyPI package: https://pypi.org/project/Pincer
｜Our website: https://pincer.dev
📝 | ReadTheDocs: https://pincer.readthedocs.io

☄️ Installation

Use the following command to install Pincer into your Python environment:

pip install pincer

To install our version with Aiohttp Speedup do:

pip install pincer[speed]

⚙️ Didn't work?

Depending on your Python installation, you might need to use one of the following:

• Python is not in PATH

  path/to/python.exe -m pip install pincer

• Python is in PATH but pip is not

  python -m pip install pincer

• Unix systems can use pip3/python3 commands

  pip3 install pincer

  python3 -m pip install pincer

• Using multiple Python versions

  py -m pip install pincer

Current Features

• Discord Gateway communication
• logging
• Http Client
• Events
• Event middleware
• Commands
• Command arguments (for types: str, int, float, bool, User, Channel, Role)
• Command argument choices
• Command argument descriptions
• Command cool downs (Using WindowSliding technique)
• Tasks
• Cogs

Client base class example:

from pincer.client import Bot

# Note that both `Bot` and `Client` are valid!
bot = Bot("...")
bot.run()

An example on the on_ready event

from time import perf_counter
from pincer.client import Client

client = Client("...")


@client.event
async def on_ready():
    print(f"Logged in as {client.bot} after {perf_counter()} seconds")


client.run()

Inherited client

You have the possibility to use your own class to inherit from the Pincer bot base.

from pincer import Client, command, Descripted


class Bot(Client):
    def __init__(self) -> None:
        super(Bot, self).__init__(token="...")

    @Client.event
    async def on_ready(self) -> None:
        ...

    @command(description="Say something as the bot!")
    # Pincer uses type hints to specify the argument type
    # str - String
    # int - Integer
    # bool - Boolean
    # float - Number
    # pincer.objects.User - User
    # pincer.objects.Channel - Channel
    # pincer.objects.Role - Role
    # Mentionable is not implemented
    async def say(self, message: str):
        return message

    @command(description="Add two numbers!")
    async def add(
            self, 
            first: Descripted[int, "The first number"],
            second: Descripted[int, "The second number"]
    ): 
        return f"The addition of `{first}` and `{second}` is `{first + second}`"

For more examples you can take a look at the examples folder or check out our bot:

https://github.com/Pincer-org/Pincer-bot

Advanced Usage

Enable the debug mode

If you want to see everything that is happening under the hood, either out of curiosity or to get a deeper insight into the implementation of some features, we provide debug logging!

import logging

logging.basicConfig(level=logging.DEBUG)

Note: A lot of printing can happen, including sensitive information, so make sure to be aware of what you're doing if you're enabling it!

Middleware

From version 0.4.0-dev, the middleware system has been introduced. This system gives you the full freedom to remove the already existing middleware which has been created by the developers and create custom events. Your custom middleware directly receives the payload from Discord. You can't really do anything wrong without accessing the override attribute, but if you access this attribute the Pincer team will not provide any support for weird behavior. So in short, only use this if you know what you're doing. An example of using this with a custom on_ready event can be found in our docs .

🏷️ License

© 2021 copyright Pincer

This repository is licensed under the MIT License.

See LICENSE for details.