Pincer

GitHub repo size GitHub last commit GitHub commit activity GitHub Code Style Discord

An asynchronous Python API wrapper meant to replace discord.py

The package is currently within the planning phase

📌 Links

Join the Discord server: https://discord.gg/8WkYz3fNFm
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

⚙️ 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)
Command argument choices
Command argument descriptions
Command cool downs (Using WindowSliding technique)

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


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!")
    async def say(self, message: str):
        return message

    @command(description="Add two numbers!")
    async def add(
            self, 
            first: (int, "The first number"), # support arg descriptions
            second: (int, "The second number") # since 0.7.1
    ): 
        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 on GitHub:

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

This repository is licensed under the MIT License.

See LICENSE for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pincer-0.8.0.tar.gz (67.2 kB view details)

Uploaded Oct 3, 2021 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pincer-0.8.0-py3-none-any.whl (106.5 kB view details)

Uploaded Oct 3, 2021 Python 3

File details

Details for the file pincer-0.8.0.tar.gz.

File metadata

Download URL: pincer-0.8.0.tar.gz
Upload date: Oct 3, 2021
Size: 67.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for pincer-0.8.0.tar.gz
Algorithm	Hash digest
SHA256	`c3934de648c7dc5a87c8fe5ca734076060e6b7028b550b9e898d80105b9f8b10`
MD5	`de1fdece7c12f1e7adf143d1f16e43e8`
BLAKE2b-256	`141ed51dcc02605c24d030d90d6af84ed74734eb740fdd88fd3590d6d2bfd81e`

See more details on using hashes here.

File details

Details for the file pincer-0.8.0-py3-none-any.whl.

File metadata

Download URL: pincer-0.8.0-py3-none-any.whl
Upload date: Oct 3, 2021
Size: 106.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for pincer-0.8.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`01ca1eaf5184799bc7f0c884531bf5e6281ce7f6dc6f90611ea3e51f579e8aac`
MD5	`78283398ba4ff81d35359c190ad3c284`
BLAKE2b-256	`40dc9af3bc8da75c2c9809a687339a73264e6497c0e8a49c8f4fb79384d02972`