This release is a pre-release and may not be stable for production use.
Pincer
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, 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!")
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 on GitHub:
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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pincer-0.11.0a0.tar.gz.
File metadata
- Download URL: pincer-0.11.0a0.tar.gz
- Upload date:
- Size: 95.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.2 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c732c8a8bf104c0d3508e65159181512146feed402824bc33b8f5639f0bd5c12
|
|
| MD5 |
ed84cd788349de57e9f79d0bbce5a83c
|
|
| BLAKE2b-256 |
312ef220303b3f57f44f9196b608535f3fae3367284b2a49ab6f74fe240077c9
|
File details
Details for the file pincer-0.11.0a0-py3-none-any.whl.
File metadata
- Download URL: pincer-0.11.0a0-py3-none-any.whl
- Upload date:
- Size: 168.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.2 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
51f1cf76d50e8bf7db63b34b742f6d2a2623a640ecc46715e94de4ef6d97ec4e
|
|
| MD5 |
44831ced34ea2318f52f266499a77471
|
|
| BLAKE2b-256 |
7b52b8481303ee3d8811422b06adf1071693c780b37c68db4458efec9d29aff1
|
