Discord API wrapper rebuild from scratch.
Project description
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
☄️ 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:
-
pip isn't in the path but python is
python -m pip install pincer
-
Unix system can use pip3/python3 command
pip3 install pincer
python3 -m pip install pincer
-
python isn't in the path
path/to/python.exe -m pip install pincer
-
Using multiple python versions
py -m pip install pincer
Current Features
- Dispatcher
- Logging Improved
- HTTP Client
- Client base class
- Basic events Improved
Client base class example:
from pincer.client import Bot
# Note that both `Bot` and `Client` are valid!
bot = Bot("...")
bot.run()
An example on 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.
class Bot(Client):
def __init__(self) -> None:
super(Bot, self).__init__(token='...')
@Client.event
async def on_ready(self) -> None:
...
See an advanced bot implementation:
Advanced Usage
Warning: These features are meant for advanced developers to make early experimentation with Pincer.
Enable the debug mode
If you want to see everything that is happening under the hood, either for curiosity or the implementation of some features, we provide a debug logging!
import logging
logging.basicConfig(level=logging.DEBUG)
Note: A lot of printing can happen, with sensitive information, make sure to be aware or what your doing if your enable it!
middleware
Within the version 0.4.0-dev, middleware system has been re-created, and now also advanced user to use them. However, it should be used carefully.
An /say command early implementation, using middleware
https://gist.github.com/Arthurdw/e110ebbdafca388722f25ddb79c1dfb8
🏷️ License
© 2021 copyright Pincer
This repository is licensed under the MIT License.
See LICENSE for details.
Project details
Release history Release notifications | RSS feed
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
Hashes for Pincer-0.4.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9078d7c5f401a738a54a9e263790587a6f0d7456c9968a3a6c3d9257a049f532 |
|
MD5 | e77f8f589d682cdef37bead869f4049b |
|
BLAKE2b-256 | 2c7f3ca74577d55152ce0473278b286038b89757400572fed20aa17b6fd8ce25 |