mirror of
https://github.com/Paillat-dev/pycord-rest.git
synced 2026-01-02 00:56:19 +00:00
Compare commits
58 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
97548eb898 | ||
|
|
3a111fc998 | ||
|
|
5295064483 | ||
|
|
03daa7e075 | ||
|
|
093f40ee7a | ||
|
|
6af19f0fb3 | ||
|
|
9e410d03f6 | ||
|
|
d7d7ad62df | ||
|
|
aebdf2655d | ||
|
|
03d58369b8 | ||
|
|
444d9272f7 | ||
|
|
9d4859caba | ||
|
|
b37d736dc3 | ||
|
|
5f3d6fab73 | ||
|
|
a63e620aad | ||
|
|
d4c54e236c | ||
|
|
7c4f032492 | ||
|
|
041e8bb6e3 | ||
|
|
2e0e835aa3 | ||
|
|
36b708f6c4 | ||
|
|
2318307378 | ||
|
|
e886d494d9 | ||
|
|
ec1efb1fb4 | ||
|
|
ed5ff75af6 | ||
|
|
844e557fc9 | ||
|
|
99a516b0f0 | ||
|
|
c356d0f74d | ||
|
|
8394b56afe | ||
| e971ba5f19 | |||
| fd45c0305e | |||
|
|
57c6a3c4cd | ||
|
|
013e4aba14 | ||
| 124ce383bb | |||
| 5827a2e98a | |||
| 5e84515c03 | |||
| 190dce6f5d | |||
| 7a98827a23 | |||
| fb9e506d15 | |||
| ad41014c94 | |||
| cd444d51d1 | |||
| a94ffb6729 | |||
| 353ae04dac | |||
| 4fe7cb47a7 | |||
| 08bf3e9521 | |||
| f6e7567d27 | |||
| 06885ace8c | |||
| b840984780 | |||
| 7874951a18 | |||
| 1ae66d05ee | |||
| d94aadae02 | |||
| 3bce16b3e7 | |||
| a133ca87cf | |||
| 2a77346690 | |||
| 7fe62afc86 | |||
|
|
5d80029515 | ||
| d7b634107b | |||
| 3d51f3092d | |||
| 12ffa85009 |
8
.github/workflows/publish.yaml
vendored
8
.github/workflows/publish.yaml
vendored
@@ -3,21 +3,21 @@ name: Quality Checks
|
|||||||
on:
|
on:
|
||||||
workflow_call:
|
workflow_call:
|
||||||
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish:
|
publish:
|
||||||
|
name: Publish to PyPI
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
environment: pypi
|
environment: pypi
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
- name: "Install uv"
|
- name: "Install uv"
|
||||||
uses: astral-sh/setup-uv@v5
|
uses: astral-sh/setup-uv@v7
|
||||||
with:
|
with:
|
||||||
enable-cache: true
|
enable-cache: true
|
||||||
|
|
||||||
- name: "Set up Python"
|
- name: "Set up Python"
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version-file: "pyproject.toml"
|
python-version-file: "pyproject.toml"
|
||||||
|
|
||||||
|
|||||||
12
.github/workflows/quality.yaml
vendored
12
.github/workflows/quality.yaml
vendored
@@ -3,15 +3,15 @@ name: Quality Checks
|
|||||||
on:
|
on:
|
||||||
workflow_call:
|
workflow_call:
|
||||||
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
check-license-header:
|
check-license-header:
|
||||||
|
name: License Header Check
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v6
|
||||||
- name: Setup Copywrite
|
- name: Setup Copywrite
|
||||||
uses: hashicorp/setup-copywrite@5e3e8a26d7b9f8a508848ad0a069dfd2f7aa5339
|
uses: hashicorp/setup-copywrite@32f9f1c86f661b8a51100768976a06f1b281a035
|
||||||
- name: Check Header Compliance
|
- name: Check Header Compliance
|
||||||
run: copywrite headers --plan --config .copywrite.hcl
|
run: copywrite headers --plan --config .copywrite.hcl
|
||||||
|
|
||||||
@@ -35,15 +35,15 @@ jobs:
|
|||||||
name: ${{ matrix.name }}
|
name: ${{ matrix.name }}
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v6
|
||||||
|
|
||||||
- name: "Install uv"
|
- name: "Install uv"
|
||||||
uses: astral-sh/setup-uv@v5
|
uses: astral-sh/setup-uv@v7
|
||||||
with:
|
with:
|
||||||
enable-cache: true
|
enable-cache: true
|
||||||
|
|
||||||
- name: "Set up Python"
|
- name: "Set up Python"
|
||||||
uses: actions/setup-python@v5
|
uses: actions/setup-python@v6
|
||||||
with:
|
with:
|
||||||
python-version-file: "pyproject.toml"
|
python-version-file: "pyproject.toml"
|
||||||
|
|
||||||
|
|||||||
6
.gitignore
vendored
6
.gitignore
vendored
@@ -85,7 +85,7 @@ ipython_config.py
|
|||||||
# pyenv
|
# pyenv
|
||||||
# For a library or package, you might want to ignore these files since the code is
|
# For a library or package, you might want to ignore these files since the code is
|
||||||
# intended to run in multiple environments; otherwise, check them in:
|
# intended to run in multiple environments; otherwise, check them in:
|
||||||
# .python-version
|
.python-version
|
||||||
|
|
||||||
# pipenv
|
# pipenv
|
||||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
||||||
@@ -165,11 +165,9 @@ cython_debug/
|
|||||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
||||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||||
#.idea/
|
.idea/
|
||||||
|
|
||||||
# PyPI configuration file
|
# PyPI configuration file
|
||||||
.pypirc
|
.pypirc
|
||||||
|
|
||||||
.python-version
|
|
||||||
.idea
|
|
||||||
_version.py
|
_version.py
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ repos:
|
|||||||
exclude: \.(po|pot|yml|yaml)$
|
exclude: \.(po|pot|yml|yaml)$
|
||||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
# Ruff version.
|
# Ruff version.
|
||||||
rev: v0.9.10
|
rev: v0.11.11
|
||||||
hooks:
|
hooks:
|
||||||
# Run the linter.
|
# Run the linter.
|
||||||
- id: ruff
|
- id: ruff
|
||||||
@@ -31,4 +31,4 @@ repos:
|
|||||||
- repo: https://github.com/bhundven/copywrite # waiting for https://github.com/hashicorp/copywrite/pull/120 to be merged
|
- repo: https://github.com/bhundven/copywrite # waiting for https://github.com/hashicorp/copywrite/pull/120 to be merged
|
||||||
rev: 937f17f09c46992447dfa8977bb96eda512588c4
|
rev: 937f17f09c46992447dfa8977bb96eda512588c4
|
||||||
hooks:
|
hooks:
|
||||||
- id: add-headers
|
- id: add-headers
|
||||||
|
|||||||
305
README.md
305
README.md
@@ -1,31 +1,72 @@
|
|||||||
# Pycord REST
|
<div align="center">
|
||||||
|
<h1>Pycord REST</h1>
|
||||||
|
|
||||||
A lightweight wrapper for Discord's HTTP interactions using py-cord and FastAPI. This
|
<!-- badges -->
|
||||||
library enables you to build Discord bots that work exclusively through Discord's HTTP
|
|
||||||
interactions, without requiring a WebSocket gateway connection.
|
|
||||||
|
|
||||||
## About
|
[](https://pypi.org/project/pycord-rest-bot/)
|
||||||
|
[](https://pypi.org/project/pycord-rest-bot/)
|
||||||
|
[](https://pypi.org/project/pycord-rest-bot/)
|
||||||
|
[](https://pypi.org/project/pycord-rest-bot/)
|
||||||
|
[](https://github.com/Paillat-dev/pycord-rest/actions/workflows/CI.yaml)
|
||||||
|
[](https://results.pre-commit.ci/latest/github/Paillat-dev/pycord-rest/main)
|
||||||
|
|
||||||
Pycord REST allows you to build Discord bots that respond to interactions via HTTP
|
<!-- end badges -->
|
||||||
endpoints as described in
|
|
||||||
[Discord's interaction documentation](https://discord.com/developers/docs/interactions/receiving-and-responding)
|
|
||||||
and
|
|
||||||
[interaction overview](https://discord.com/developers/docs/interactions/overview#preparing-for-interactions).
|
|
||||||
|
|
||||||
This project is built on:
|
<!-- short description -->
|
||||||
|
|
||||||
- **FastAPI** - For handling the HTTP server
|
A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord
|
||||||
- **py-cord** - Leveraging Discord command builders and interaction handling
|
and FastAPI.
|
||||||
|
|
||||||
|
<!-- end short description -->
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- toc -->
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Overview](#overview)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Quick Start](#quick-start)
|
||||||
|
- [Core Concepts](#core-concepts)
|
||||||
|
- [How It Works](#how-it-works)
|
||||||
|
- [Discord Application Setup](#discord-application-setup)
|
||||||
|
- [Features](#features)
|
||||||
|
- [Interaction Handling](#interaction-handling)
|
||||||
|
- [Webhook Events](#webhook-events)
|
||||||
|
- [Type Safety](#type-safety)
|
||||||
|
- [Usage Examples](#usage-examples)
|
||||||
|
- [Basic Commands](#basic-commands)
|
||||||
|
- [Event Handling](#event-handling)
|
||||||
|
- [Custom Routes](#custom-routes)
|
||||||
|
- [Configuration](#configuration)
|
||||||
|
- [Limitations](#limitations)
|
||||||
|
- [Getting Help](#getting-help)
|
||||||
|
- [Development](#development)
|
||||||
|
- [Local Testing](#local-testing)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Pycord REST enables you to build Discord applications that respond to:
|
||||||
|
|
||||||
|
- **Interactions** via HTTP endpoints (slash commands, components, modals)
|
||||||
|
- **Webhook events** such as application authorization and entitlements
|
||||||
|
|
||||||
|
Built on:
|
||||||
|
|
||||||
|
- **FastAPI** - For handling HTTP requests
|
||||||
|
- **py-cord** - For Discord command builders and interaction handling
|
||||||
- **uvicorn** - ASGI server implementation
|
- **uvicorn** - ASGI server implementation
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install pycord-rest-bot --prerelease=allow
|
pip install pycord-rest-bot
|
||||||
```
|
```
|
||||||
|
|
||||||
Currently, the package is in pre-release, so you need to use the `--prerelease=allow`
|
<!-- quick-start -->
|
||||||
flag to install it.
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
@@ -50,48 +91,77 @@ if __name__ == "__main__":
|
|||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
For more examples, check out the [examples directory](/examples) which includes:
|
## Core Concepts
|
||||||
|
|
||||||
- Basic slash command setup
|
### How It Works
|
||||||
- Button interactions
|
|
||||||
- Modal forms
|
|
||||||
|
|
||||||
## How It Works
|
Pycord REST creates an HTTP server that:
|
||||||
|
|
||||||
Under the hood, Pycord REST creates an HTTP server using FastAPI and Uvicorn that:
|
1. Listens for Discord interaction requests and webhook events
|
||||||
|
2. Verifies request signatures using your application's public key
|
||||||
|
3. Routes events to appropriate handlers
|
||||||
|
4. Returns responses back to Discord
|
||||||
|
|
||||||
1. Listens for incoming Discord interaction requests on your specified endpoint
|
Unlike traditional WebSocket-based Discord bots, HTTP-based applications:
|
||||||
2. Verifies the request signature using your application's public key
|
|
||||||
3. Routes the interaction to the appropriate command handler
|
|
||||||
4. Returns the response back to Discord
|
|
||||||
|
|
||||||
Unlike traditional Discord bots that maintain a persistent WebSocket connection to
|
- Only wake up when receiving interactions or webhook events
|
||||||
Discord's gateway, HTTP-based bots:
|
- Don't maintain a persistent connection to Discord's gateway
|
||||||
|
- Don't receive most real-time Discord events
|
||||||
|
|
||||||
- Only wake up when an interaction is received
|
### Discord Application Setup
|
||||||
- Don't receive real-time events from Discord
|
|
||||||
|
|
||||||
## Usage
|
1. Create an application on the
|
||||||
|
|
||||||
### Setting up your bot on Discord
|
|
||||||
|
|
||||||
1. Create a bot on the
|
|
||||||
[Discord Developer Portal](https://discord.com/developers/applications)
|
[Discord Developer Portal](https://discord.com/developers/applications)
|
||||||
2. Enable the "Interactions Endpoint URL" for your application
|
2. Copy your public key to verify signatures
|
||||||
3. Set the URL to your public endpoint where your bot will receive interactions
|
3. Run the Pycord REST app
|
||||||
4. Copy your public key from the Developer Portal to verify signatures
|
4. Configure the endpoints:
|
||||||
|
|
||||||
### Features
|
- **Interactions Endpoint URL** - For slash commands and component interactions
|
||||||
|
(`https://example.com`)
|
||||||
|
- **Webhook URL** - For receiving application events (e.g.,
|
||||||
|
`https://example.com/webhook`)
|
||||||
|
|
||||||
- Slash Commands
|
<!-- prettier-ignore -->
|
||||||
- UI Components (buttons, select menus)
|
> [!IMPORTANT]
|
||||||
- Modal interactions
|
> Don't forget to run your FastAPI server **before** setting up the application on Discord, or else Discord won't be able to verify the endpoints.
|
||||||
- Autocomplete for commands
|
|
||||||
|
|
||||||
### Similarities to py-cord
|
## Features
|
||||||
|
|
||||||
Syntax is equivalent to py-cord, as it is what is being used under the hood, making it
|
### Interaction Handling
|
||||||
easy to adapt existing bots:
|
|
||||||
|
Respond to Discord interactions such as:
|
||||||
|
|
||||||
|
- **Slash Commands** - Create and respond to application commands
|
||||||
|
- **UI Components** - Buttons, select menus, and other interactive elements
|
||||||
|
- **Modal Forms** - Pop-up forms for gathering user input
|
||||||
|
- **Autocomplete** - Dynamic option suggestions as users type
|
||||||
|
|
||||||
|
### Webhook Events
|
||||||
|
|
||||||
|
Handle Discord webhook events such as:
|
||||||
|
|
||||||
|
- **Application authorization** - When your app is added to a guild or authorized by a
|
||||||
|
user
|
||||||
|
- **Entitlement creation** - When a user subscribes to your app's premium features
|
||||||
|
|
||||||
|
### Type Safety
|
||||||
|
|
||||||
|
Pycord REST is fully type-annotated and type-safe. It uses `basedpyright` for type
|
||||||
|
checking.
|
||||||
|
|
||||||
|
<!-- prettier-ignore -->
|
||||||
|
> [!NOTE]
|
||||||
|
> While Pycord REST itself is fully typed, the underlying py-cord library has limited type annotations, which may affect type checking in some areas.
|
||||||
|
|
||||||
|
## Usage Examples
|
||||||
|
|
||||||
|
<!-- prettier-ignore -->
|
||||||
|
> [!TIP]
|
||||||
|
> For complete examples, check out the [examples directory](/examples).
|
||||||
|
|
||||||
|
### Basic Commands
|
||||||
|
|
||||||
|
Commands use the familiar py-cord syntax:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
@app.slash_command(name="hello", description="Say hello")
|
@app.slash_command(name="hello", description="Say hello")
|
||||||
@@ -106,57 +176,28 @@ async def button(ctx):
|
|||||||
await ctx.respond("Press the button!", view=view)
|
await ctx.respond("Press the button!", view=view)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Limitations
|
### Event Handling
|
||||||
|
|
||||||
This library works differently than traditional bots because it does not use Discord's
|
The possible events are:
|
||||||
WebSocket gateway:
|
|
||||||
|
|
||||||
- **No Cache**: Since there's no gateway connection, there's no cache of guilds,
|
- `on_application_authorized` - When your app is added to a guild or authorized by a
|
||||||
channels, users, etc.
|
user
|
||||||
- **Limited API Methods**: Many standard py-cord methods that rely on cache won't work
|
- `on_entitlement_create` - When a user subscribes to your app's premium features
|
||||||
properly:
|
|
||||||
- `app.get_channel()`, `app.get_guild()`, `app.get_user()`, etc.
|
|
||||||
- Presence updates
|
|
||||||
- Voice support
|
|
||||||
- Member tracking
|
|
||||||
- **Event-Based Functions**: Only interaction-based events work; message events, etc.
|
|
||||||
don't work
|
|
||||||
|
|
||||||
Remember that this is an HTTP-only bot that responds exclusively to interactions
|
<!-- prettier-ignore -->
|
||||||
triggered by users.
|
> [!NOTE]
|
||||||
|
> For application installation events, use `on_application_authorized` instead of `on_guild_join`.
|
||||||
## Configuration Options
|
|
||||||
|
|
||||||
```python
|
```python
|
||||||
app.run(
|
@app.listen("on_application_authorized")
|
||||||
token="YOUR_BOT_TOKEN",
|
async def on_application_authorized(event: ApplicationAuthorizedEvent):
|
||||||
public_key="YOUR_PUBLIC_KEY",
|
# Triggers when app is added to a guild OR when a user authorizes your app
|
||||||
uvicorn_options={
|
print(f"Authorization received: Guild={event.guild}, User={event.user}")
|
||||||
"host": "0.0.0.0", # Listen on all network interfaces
|
|
||||||
"port": 8000, # Port to listen on
|
|
||||||
"log_level": "info", # Uvicorn logging level
|
|
||||||
# Any valid uvicorn server options
|
|
||||||
},
|
|
||||||
health=True # Enable /health endpoint
|
|
||||||
)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Server Configuration
|
### Custom Routes
|
||||||
|
|
||||||
For Discord to reach your bot, you need a publicly accessible HTTPS URL. Options
|
Add your own FastAPI routes:
|
||||||
include:
|
|
||||||
|
|
||||||
- Using a VPS with a domain and SSL certificate
|
|
||||||
- Deploying to a cloud service like Heroku, Railway, or Fly.io
|
|
||||||
|
|
||||||
### Health Check
|
|
||||||
|
|
||||||
By default, Pycord REST includes a `/health` endpoint that returns a 200 status code.
|
|
||||||
This endpoint is useful for monitoring services like UptimeRobot or health checks.
|
|
||||||
|
|
||||||
## Advanced Usage
|
|
||||||
|
|
||||||
### Adding Custom FastAPI Routes
|
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from fastapi import Request
|
from fastapi import Request
|
||||||
@@ -166,12 +207,63 @@ async def custom_endpoint(request: Request):
|
|||||||
return {"message": "This is a custom endpoint"}
|
return {"message": "This is a custom endpoint"}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development Workflow
|
## Configuration
|
||||||
|
|
||||||
For faster development and testing, you can use tunneling tools to expose your local
|
```python
|
||||||
development server:
|
app.run(
|
||||||
|
token="YOUR_BOT_TOKEN",
|
||||||
|
public_key="YOUR_PUBLIC_KEY",
|
||||||
|
uvicorn_options={
|
||||||
|
"host": "0.0.0.0", # Listen on all network interfaces
|
||||||
|
"port": 8000, # Port to listen on
|
||||||
|
"log_level": "info", # Uvicorn logging level
|
||||||
|
},
|
||||||
|
health=True # Enable /health endpoint for monitoring
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
- **ngrok** - Creates a secure tunnel to your localhost
|
### Integration Options
|
||||||
|
|
||||||
|
1. **Stand-alone HTTP Interaction Bot** - Commands and components only
|
||||||
|
2. **Webhook Event Handler Only** - Process application events alongside a separate
|
||||||
|
gateway bot
|
||||||
|
3. **Full HTTP Application** - Handle both interactions and webhook events
|
||||||
|
|
||||||
|
## Limitations
|
||||||
|
|
||||||
|
Since Pycord REST doesn't use Discord's WebSocket gateway:
|
||||||
|
|
||||||
|
- **No Cache** - No local storage of guilds, channels, or users
|
||||||
|
- **Limited API Methods** - Functions that rely on cache won't work:
|
||||||
|
- `app.get_channel()`, `app.get_guild()`, `app.get_user()`
|
||||||
|
- Presence updates
|
||||||
|
- Voice support
|
||||||
|
- Member tracking
|
||||||
|
- **Limited Events** - Only interaction-based and webhook events work
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
If you encounter issues or have questions about pycord-rest:
|
||||||
|
|
||||||
|
- **GitHub Issues**:
|
||||||
|
[Submit a bug report or feature request](https://github.com/Paillat-dev/pycord-rest/issues)
|
||||||
|
- **Discord Support**:
|
||||||
|
- For py-cord related questions: Join the
|
||||||
|
[Pycord Official Server](https://discord.gg/pycord)
|
||||||
|
- For pycord-rest specific help: Join the
|
||||||
|
[Pycord Official Server](https://discord.gg/pycord) and mention `@paillat`
|
||||||
|
|
||||||
|
<!-- prettier-ignore -->
|
||||||
|
> [!TIP]
|
||||||
|
> Before asking for help, check if your question is already answered in the [examples directory](/examples) or existing GitHub issues.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
### Local Testing
|
||||||
|
|
||||||
|
Use tunneling tools to expose your local development server:
|
||||||
|
|
||||||
|
- **ngrok**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install ngrok
|
# Install ngrok
|
||||||
@@ -181,34 +273,29 @@ development server:
|
|||||||
ngrok http 8000
|
ngrok http 8000
|
||||||
```
|
```
|
||||||
|
|
||||||
- **Cloudflare Tunnel** - Provides a secure connection to your local server
|
- **Cloudflare Tunnel** or **localtunnel** - Alternative tunneling options
|
||||||
- **localtunnel** - Simple tunnel service for exposing local endpoints
|
|
||||||
|
|
||||||
These tools provide temporary URLs that you can use in the Discord Developer Portal
|
These tools provide temporary URLs for testing without deploying to production.
|
||||||
during development, allowing you to test changes quickly without deploying to
|
|
||||||
production.
|
|
||||||
|
|
||||||
## Contributing
|
### Contributing
|
||||||
|
|
||||||
Contributions are welcome! This project is in early development, so there might be bugs
|
|
||||||
or unexpected behaviors.
|
|
||||||
|
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
2. Create a feature branch
|
2. Create a feature branch
|
||||||
3. Make your changes
|
3. Make your changes
|
||||||
4. Run tests and linting: `ruff check` and `ruff format`
|
4. Run linter, formatter and type checker: `ruff check .`,`ruff format .`,
|
||||||
|
`basedpyright .`
|
||||||
5. Submit a pull request
|
5. Submit a pull request
|
||||||
|
|
||||||
### Development Tools
|
**Development Tools**:
|
||||||
|
|
||||||
|
- **uv**: For dependency management
|
||||||
- **Ruff**: For linting and formatting
|
- **Ruff**: For linting and formatting
|
||||||
- **HashiCorp Copywrite**: For managing license headers
|
- **HashiCorp Copywrite**: For managing license headers
|
||||||
- **basedpyright**: For type checking
|
- **basedpyright**: For type checking
|
||||||
|
|
||||||
## Disclaimer
|
<!-- prettier-ignore -->
|
||||||
|
> [!NOTE]
|
||||||
This is an early-stage project and may have unexpected behaviors or bugs. Please report
|
> This is an early-stage project and may have unexpected behaviors or bugs. Please report any issues you encounter.
|
||||||
any issues you encounter.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
@@ -216,4 +303,4 @@ MIT License - Copyright (c) 2025 Paillat-dev
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Made with ❤️ by Paillat-dev
|
Made with ❤ by Paillat-dev
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ class MyView(discord.ui.View):
|
|||||||
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
||||||
super().__init__(*args, **kwargs)
|
super().__init__(*args, **kwargs)
|
||||||
self.add_item(
|
self.add_item(
|
||||||
discord.ui.Button(
|
discord.ui.Button( # pyright: ignore[reportUnknownArgumentType]
|
||||||
style=discord.ButtonStyle.link, label="GitHub", url="https://github.com/Paillat-dev/pycord-rest"
|
style=discord.ButtonStyle.link, label="GitHub", url="https://github.com/Paillat-dev/pycord-rest"
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|||||||
41
examples/webhook_events.py
Normal file
41
examples/webhook_events.py
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
# Copyright (c) Paillat-dev
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
"""Example showing how to work with webhook events in Pycord REST."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
|
||||||
|
from dotenv import load_dotenv
|
||||||
|
|
||||||
|
from pycord_rest import App, ApplicationAuthorizedEvent
|
||||||
|
|
||||||
|
# Load environment variables from .env file
|
||||||
|
load_dotenv()
|
||||||
|
|
||||||
|
app = App()
|
||||||
|
|
||||||
|
|
||||||
|
# Register the event handler
|
||||||
|
@app.listen("on_application_authorized")
|
||||||
|
async def on_application_authorized(event: ApplicationAuthorizedEvent) -> None:
|
||||||
|
if not event.guild:
|
||||||
|
print(f"User {event.user.display_name} ({event.user.id}) installed the application.")
|
||||||
|
|
||||||
|
else:
|
||||||
|
print(
|
||||||
|
f"Bot {event.user.display_name} ({event.user.id}) installed the application"
|
||||||
|
+ f" to guild {event.guild.name} ({event.guild.id})."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# Run the app
|
||||||
|
if __name__ == "__main__":
|
||||||
|
app.run(
|
||||||
|
token=os.environ["DISCORD_TOKEN"],
|
||||||
|
public_key=os.environ["DISCORD_PUBLIC_KEY"],
|
||||||
|
uvicorn_options={
|
||||||
|
"host": "0.0.0.0", # noqa: S104
|
||||||
|
"port": 8000,
|
||||||
|
"log_level": "info",
|
||||||
|
},
|
||||||
|
)
|
||||||
@@ -1,25 +1,30 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["hatchling", "hatch-vcs", "hatch-fancy-pypi-readme"]
|
||||||
|
build-backend = "hatchling.build"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "pycord-rest-bot"
|
name = "pycord-rest-bot"
|
||||||
dynamic = ["version", "urls"]
|
dynamic = ["version", "urls", "readme"]
|
||||||
description = "A discord rest-bot wrapper for pycord"
|
description = "A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord and FastAPI"
|
||||||
readme = "README.md"
|
|
||||||
authors = [
|
authors = [
|
||||||
{ name = "Paillat-dev", email = "me@paillat.dev" }
|
{ name = "Paillat-dev", email = "me@paillat.dev" }
|
||||||
]
|
]
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
requires-python = "==3.12.*"
|
requires-python = ">=3.12, <4.0"
|
||||||
classifiers = [
|
classifiers = [
|
||||||
"Development Status :: 3 - Alpha",
|
"Development Status :: 3 - Alpha",
|
||||||
"Intended Audience :: Developers",
|
"Intended Audience :: Developers",
|
||||||
"License :: OSI Approved :: MIT License",
|
"License :: OSI Approved :: MIT License",
|
||||||
"Programming Language :: Python :: 3 :: Only",
|
"Programming Language :: Python :: 3 :: Only",
|
||||||
"Programming Language :: Python :: 3.12"
|
"Programming Language :: Python :: 3.12",
|
||||||
|
"Typing :: Typed",
|
||||||
|
"Operating System :: OS Independent",
|
||||||
]
|
]
|
||||||
keywords = ["discord", "bot", "rest", "pycord"]
|
keywords = ["discord", "bot", "rest", "pycord"]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"fastapi>=0.115.11",
|
"fastapi>=0.115.11",
|
||||||
"orjson>=3.10.15",
|
"orjson>=3.10.15",
|
||||||
"py-cord==2.6.1",
|
"py-cord>=2.7.0rc1",
|
||||||
"pynacl>=1.5.0",
|
"pynacl>=1.5.0",
|
||||||
"uvicorn>=0.34.0",
|
"uvicorn>=0.34.0",
|
||||||
]
|
]
|
||||||
@@ -31,10 +36,6 @@ dev = [
|
|||||||
"ruff>=0.9.9",
|
"ruff>=0.9.9",
|
||||||
]
|
]
|
||||||
|
|
||||||
[build-system]
|
|
||||||
requires = ["hatchling", "hatch-vcs"]
|
|
||||||
build-backend = "hatchling.build"
|
|
||||||
|
|
||||||
[tool.hatch.version]
|
[tool.hatch.version]
|
||||||
source = "vcs"
|
source = "vcs"
|
||||||
|
|
||||||
@@ -45,6 +46,34 @@ version-file = "src/pycord_rest/_version.py"
|
|||||||
Homepage = "https://github.com/Paillat-dev/pycord-rest"
|
Homepage = "https://github.com/Paillat-dev/pycord-rest"
|
||||||
source_archive = "https://github.com/Paillat-dev/pycord-rest/archive/{commit_hash}.zip"
|
source_archive = "https://github.com/Paillat-dev/pycord-rest/archive/{commit_hash}.zip"
|
||||||
|
|
||||||
|
[tool.hatch.metadata.hooks.fancy-pypi-readme]
|
||||||
|
content-type = "text/markdown"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
|
||||||
|
path = "README.md"
|
||||||
|
start-after = "<!-- badges -->\n"
|
||||||
|
end-before = "\n<!-- end badges -->"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
|
||||||
|
text = "\n\n---\n"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
|
||||||
|
path = "README.md"
|
||||||
|
start-after = "## Overview\n"
|
||||||
|
end-before = "\n## Installation"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
|
||||||
|
path = "README.md"
|
||||||
|
start-after = "<!-- quick-start -->"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
|
||||||
|
pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
|
||||||
|
replacement = '[\1](https://github.com/Paillat-dev/pycord-rest/tree/main\g<2>)'
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
|
||||||
|
pattern = '\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\]'
|
||||||
|
replacement = '**\1**:'
|
||||||
|
|
||||||
[tool.hatchling]
|
[tool.hatchling]
|
||||||
name = "pycord-rest-bot"
|
name = "pycord-rest-bot"
|
||||||
|
|
||||||
@@ -69,7 +98,7 @@ reportUnusedCallResult = false
|
|||||||
reportAny = false
|
reportAny = false
|
||||||
executionEnvironments = [
|
executionEnvironments = [
|
||||||
{ root = "src/pycord_rest/_version.py", reportDeprecated = false },
|
{ root = "src/pycord_rest/_version.py", reportDeprecated = false },
|
||||||
{ root = "examples", reportExplicitAny = false, reportUnknownMemberType = false, reportUnusedParameter = false, reportImplicitOverride = false }
|
{ root = "examples", reportExplicitAny = false, reportUnknownMemberType = false, reportUnusedParameter = false, reportImplicitOverride = false, reportAttributeAccessIssue = false, reportUnknownVariableType = false },
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.ruff]
|
[tool.ruff]
|
||||||
@@ -90,7 +119,7 @@ exclude = [
|
|||||||
|
|
||||||
[tool.ruff.lint]
|
[tool.ruff.lint]
|
||||||
select = ["ALL"]
|
select = ["ALL"]
|
||||||
per-file-ignores = { "examples/**/*" = ["INP001", "ARG002"] }
|
per-file-ignores = { "examples/**/*" = ["INP001", "ARG002", "T201"] }
|
||||||
extend-ignore = [
|
extend-ignore = [
|
||||||
"N999",
|
"N999",
|
||||||
"D104",
|
"D104",
|
||||||
@@ -116,5 +145,6 @@ extend-ignore = [
|
|||||||
"FBT002",
|
"FBT002",
|
||||||
"PLR2004",
|
"PLR2004",
|
||||||
"PLR0913",
|
"PLR0913",
|
||||||
"C901"
|
"C901",
|
||||||
|
"ISC003" # conflicts with basedpyright reportImplicitStringConcatenation
|
||||||
]
|
]
|
||||||
|
|||||||
13
renovate.json
Normal file
13
renovate.json
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||||
|
"extends": [
|
||||||
|
"local>nicebots-xyz/renovate-config",
|
||||||
|
":semanticPrefixFixDepsChoreOthers",
|
||||||
|
":dependencyDashboard"
|
||||||
|
],
|
||||||
|
"forkProcessing": "enabled",
|
||||||
|
"baseBranchPatterns": ["main"],
|
||||||
|
"lockFileMaintenance": {
|
||||||
|
"enabled": true
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
# Copyright (c) Paillat-dev
|
# Copyright (c) Paillat-dev
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
from .app import App
|
from .app import App, ApplicationAuthorizedEvent
|
||||||
|
|
||||||
Bot = App
|
Bot = App
|
||||||
|
|
||||||
__all__ = ["App", "Bot"]
|
__all__ = ["App", "ApplicationAuthorizedEvent", "Bot"]
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
# Copyright (c) Paillat-dev
|
# Copyright (c) Paillat-dev
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import functools
|
||||||
import logging
|
import logging
|
||||||
|
import warnings
|
||||||
from collections.abc import Callable, Coroutine
|
from collections.abc import Callable, Coroutine
|
||||||
from functools import cached_property
|
from functools import cached_property
|
||||||
from typing import Any, Never, override
|
from typing import Any, Never, override
|
||||||
@@ -9,50 +12,92 @@ from typing import Any, Never, override
|
|||||||
import aiohttp
|
import aiohttp
|
||||||
import discord
|
import discord
|
||||||
import uvicorn
|
import uvicorn
|
||||||
from discord import Interaction, InteractionType
|
from discord import Entitlement, Interaction, InteractionType
|
||||||
from fastapi import APIRouter, Depends, FastAPI, HTTPException, Request
|
from fastapi import APIRouter, Depends, FastAPI, HTTPException, Request, Response
|
||||||
from fastapi.exceptions import FastAPIError
|
|
||||||
from nacl.exceptions import BadSignatureError
|
from nacl.exceptions import BadSignatureError
|
||||||
from nacl.signing import VerifyKey
|
from nacl.signing import VerifyKey
|
||||||
|
|
||||||
|
from .errors import InvalidCredentialsError
|
||||||
|
from .models import EventType, WebhookEventPayload, WebhookType
|
||||||
|
|
||||||
logger = logging.getLogger("pycord.rest")
|
logger = logging.getLogger("pycord.rest")
|
||||||
|
|
||||||
|
|
||||||
|
class ApplicationAuthorizedEvent:
|
||||||
|
def __init__(self, user: discord.User, guild: discord.Guild | None, type: discord.IntegrationType) -> None: # noqa: A002
|
||||||
|
self.type: discord.IntegrationType = type
|
||||||
|
self.user: discord.User = user
|
||||||
|
self.guild: discord.Guild | None = guild
|
||||||
|
|
||||||
|
@override
|
||||||
|
def __repr__(self) -> str:
|
||||||
|
return (
|
||||||
|
f"<ApplicationAuthorizedEvent type={self.type} user={self.user}"
|
||||||
|
+ (f" guild={self.guild}" if self.guild else "")
|
||||||
|
+ ">"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def not_supported[T, U](func: Callable[[T], U]) -> Callable[[T], U]:
|
||||||
|
@functools.wraps(func)
|
||||||
|
def inner(*args: T, **kwargs: T) -> U:
|
||||||
|
logger.warning(f"{func.__qualname__} is not supported by REST apps.")
|
||||||
|
warnings.warn(
|
||||||
|
f"{func.__qualname__} is not supported by REST apps.",
|
||||||
|
SyntaxWarning,
|
||||||
|
stacklevel=2,
|
||||||
|
)
|
||||||
|
return func(*args, **kwargs)
|
||||||
|
|
||||||
|
return inner
|
||||||
|
|
||||||
|
|
||||||
class App(discord.Bot):
|
class App(discord.Bot):
|
||||||
def __init__(self, *args: Any, **options: Any) -> None: # pyright: ignore [reportExplicitAny]
|
_UvicornConfig: type[uvicorn.Config] = uvicorn.Config
|
||||||
|
_UvicornServer: type[uvicorn.Server] = uvicorn.Server
|
||||||
|
_FastAPI: type[FastAPI] = FastAPI
|
||||||
|
_APIRouter: type[APIRouter] = APIRouter
|
||||||
|
|
||||||
|
def __init__(self, *args: Any, path_prefix: str = "", **options: Any) -> None: # pyright: ignore [reportExplicitAny]
|
||||||
super().__init__(*args, **options) # pyright: ignore [reportUnknownMemberType]
|
super().__init__(*args, **options) # pyright: ignore [reportUnknownMemberType]
|
||||||
self.app: FastAPI = FastAPI(openapi_url=None, docs_url=None, redoc_url=None)
|
self._app: FastAPI = self._FastAPI(openapi_url=None, docs_url=None, redoc_url=None)
|
||||||
self.router: APIRouter = APIRouter()
|
self.router: APIRouter = self._APIRouter(prefix=path_prefix)
|
||||||
self.public_key: str | None = None
|
self._public_key: str | None = None
|
||||||
|
|
||||||
|
@property
|
||||||
|
@override
|
||||||
|
@not_supported
|
||||||
|
def latency(self) -> float:
|
||||||
|
return 0.0
|
||||||
|
|
||||||
@cached_property
|
@cached_property
|
||||||
def _verify_key(self) -> VerifyKey:
|
def _verify_key(self) -> VerifyKey:
|
||||||
if self.public_key is None:
|
if self._public_key is None:
|
||||||
raise FastAPIError("No public key provided")
|
raise InvalidCredentialsError("No public key provided")
|
||||||
return VerifyKey(bytes.fromhex(self.public_key))
|
return VerifyKey(bytes.fromhex(self._public_key))
|
||||||
|
|
||||||
async def _dispatch_view(self, component_type: int, custom_id: str, interaction: Interaction) -> None:
|
async def _dispatch_view(self, component_type: int, custom_id: str, interaction: Interaction) -> None:
|
||||||
# Code taken from ViewStore.dispatch
|
# Code taken from ViewStore.dispatch
|
||||||
self._connection._view_store._ViewStore__verify_integrity() # noqa: SLF001 # pyright: ignore [reportUnknownMemberType, reportAttributeAccessIssue, reportPrivateUsage]
|
self._connection._view_store._ViewStore__verify_integrity() # noqa: SLF001 # pyright: ignore [reportUnknownMemberType, reportAttributeAccessIssue, reportPrivateUsage]
|
||||||
message_id: int | None = interaction.message and interaction.message.id
|
message_id: int | None = interaction.message and interaction.message.id
|
||||||
key = (component_type, message_id, custom_id)
|
key = (component_type, message_id, custom_id)
|
||||||
value = self._connection._view_store._views.get(key) or self._connection._view_store._views.get( # pyright: ignore [reportUnknownVariableType, reportUnknownMemberType, reportPrivateUsage] # noqa: SLF001
|
value = self._connection._view_store._views.get(key) or self._connection._view_store._views.get( # pyright: ignore [reportPrivateUsage] # noqa: SLF001
|
||||||
(component_type, None, custom_id)
|
(component_type, None, custom_id)
|
||||||
)
|
)
|
||||||
if value is None:
|
if value is None:
|
||||||
return
|
return
|
||||||
|
|
||||||
view, item = value # pyright: ignore [reportUnknownVariableType]
|
view, item = value
|
||||||
item.refresh_state(interaction)
|
item.refresh_state(interaction)
|
||||||
|
|
||||||
# Code taken from View._dispatch_item
|
# Code taken from View._dispatch_item
|
||||||
if view._View__stopped.done(): # noqa: SLF001 # pyright: ignore [reportAttributeAccessIssue, reportUnknownMemberType]
|
if view._stopped.done(): # noqa: SLF001 # pyright: ignore [reportPrivateUsage]
|
||||||
return
|
return
|
||||||
|
|
||||||
if interaction.message:
|
if interaction.message:
|
||||||
view.message = interaction.message
|
view.message = interaction.message
|
||||||
|
|
||||||
await view._scheduled_task(item, interaction) # noqa: SLF001 # pyright: ignore [reportPrivateUsage, reportUnknownMemberType]
|
await view._scheduled_task(item, interaction) # noqa: SLF001 # pyright: ignore [reportPrivateUsage]
|
||||||
|
|
||||||
async def _verify_request(self, request: Request) -> None:
|
async def _verify_request(self, request: Request) -> None:
|
||||||
signature = request.headers["X-Signature-Ed25519"]
|
signature = request.headers["X-Signature-Ed25519"]
|
||||||
@@ -93,6 +138,7 @@ class App(discord.Bot):
|
|||||||
async def process_application_commands( # noqa: PLR0912
|
async def process_application_commands( # noqa: PLR0912
|
||||||
self, interaction: Interaction, auto_sync: bool | None = None
|
self, interaction: Interaction, auto_sync: bool | None = None
|
||||||
) -> None:
|
) -> None:
|
||||||
|
# Code taken from super().process_application_commands
|
||||||
if auto_sync is None:
|
if auto_sync is None:
|
||||||
auto_sync = self._bot.auto_sync_commands # pyright: ignore [reportUnknownVariableType, reportUnknownMemberType]
|
auto_sync = self._bot.auto_sync_commands # pyright: ignore [reportUnknownVariableType, reportUnknownMemberType]
|
||||||
# TODO: find out why the isinstance check below doesn't stop the type errors below # noqa: FIX002, TD002, TD003
|
# TODO: find out why the isinstance check below doesn't stop the type errors below # noqa: FIX002, TD002, TD003
|
||||||
@@ -162,6 +208,50 @@ class App(discord.Bot):
|
|||||||
|
|
||||||
return health
|
return health
|
||||||
|
|
||||||
|
async def _handle_webhook_event(self, data: dict[str, Any] | None, event_type: EventType) -> None: # pyright: ignore [reportExplicitAny]
|
||||||
|
if not data:
|
||||||
|
raise HTTPException(status_code=400, detail="Missing event data")
|
||||||
|
|
||||||
|
match event_type:
|
||||||
|
case EventType.APPLICATION_AUTHORIZED:
|
||||||
|
event = ApplicationAuthorizedEvent(
|
||||||
|
user=discord.User(state=self._connection, data=data["user"]),
|
||||||
|
guild=(discord.Guild(state=self._connection, data=data["guild"]) if data.get("guild") else None),
|
||||||
|
type=discord.IntegrationType.guild_install
|
||||||
|
if data.get("guild")
|
||||||
|
else discord.IntegrationType.user_install,
|
||||||
|
)
|
||||||
|
logger.debug("Dispatching application_authorized event")
|
||||||
|
self.dispatch("application_authorized", event)
|
||||||
|
if event.type == discord.IntegrationType.guild_install:
|
||||||
|
self.dispatch("guild_join", event.guild)
|
||||||
|
case EventType.ENTITLEMENT_CREATE:
|
||||||
|
entitlement = Entitlement(data=data, state=self._connection) # pyright: ignore [reportArgumentType]
|
||||||
|
logger.debug("Dispatching entitlement_create event")
|
||||||
|
self.dispatch("entitlement_create", entitlement)
|
||||||
|
case _:
|
||||||
|
logger.warning(f"Unsupported webhook event type received: {event_type}")
|
||||||
|
|
||||||
|
async def _webhook_event(self, payload: WebhookEventPayload) -> Response | dict[str, Any]: # pyright: ignore [reportExplicitAny]
|
||||||
|
match payload.type:
|
||||||
|
case WebhookType.PING:
|
||||||
|
return Response(status_code=204)
|
||||||
|
case WebhookType.Event:
|
||||||
|
if not payload.event:
|
||||||
|
raise HTTPException(status_code=400, detail="Missing event data")
|
||||||
|
await self._handle_webhook_event(payload.event.data, payload.event.type)
|
||||||
|
|
||||||
|
return {"ok": True}
|
||||||
|
|
||||||
|
def _webhook_event_factory(
|
||||||
|
self,
|
||||||
|
) -> Callable[[WebhookEventPayload], Coroutine[Any, Any, Response | dict[str, Any]]]: # pyright: ignore [reportExplicitAny]
|
||||||
|
@self.router.post("/webhook", dependencies=[Depends(self._verify_request)], response_model=None)
|
||||||
|
async def webhook_event(payload: WebhookEventPayload) -> Response | dict[str, Any]: # pyright: ignore [reportExplicitAny]
|
||||||
|
return await self._webhook_event(payload)
|
||||||
|
|
||||||
|
return webhook_event
|
||||||
|
|
||||||
@override
|
@override
|
||||||
async def connect( # pyright: ignore [reportIncompatibleMethodOverride]
|
async def connect( # pyright: ignore [reportIncompatibleMethodOverride]
|
||||||
self,
|
self,
|
||||||
@@ -170,16 +260,18 @@ class App(discord.Bot):
|
|||||||
uvicorn_options: dict[str, Any] | None = None, # pyright: ignore [reportExplicitAny]
|
uvicorn_options: dict[str, Any] | None = None, # pyright: ignore [reportExplicitAny]
|
||||||
health: bool = True,
|
health: bool = True,
|
||||||
) -> None:
|
) -> None:
|
||||||
self.public_key = public_key
|
self._public_key = public_key
|
||||||
_ = self._process_interaction_factory()
|
_ = self._process_interaction_factory()
|
||||||
self.app.include_router(self.router)
|
_ = self._webhook_event_factory()
|
||||||
if health:
|
if health:
|
||||||
_ = self._health_factory()
|
_ = self._health_factory()
|
||||||
self.app.include_router(self.router)
|
self._app.include_router(self.router)
|
||||||
uvicorn_options = uvicorn_options or {}
|
uvicorn_options = uvicorn_options or {}
|
||||||
uvicorn_options["log_level"] = uvicorn_options.get("log_level", logging.root.level)
|
uvicorn_options["log_level"] = uvicorn_options.get("log_level", logging.root.level)
|
||||||
config = uvicorn.Config(self.app, **uvicorn_options)
|
uvicorn_options["server_header"] = uvicorn_options.get("server_header", False)
|
||||||
server = uvicorn.Server(config)
|
config = self._UvicornConfig(self._app, **uvicorn_options)
|
||||||
|
server = self._UvicornServer(config)
|
||||||
|
self._connection.application_id = int(base64.b64decode(token.split(".")[0] + "==").decode("utf-8"))
|
||||||
try:
|
try:
|
||||||
self.dispatch("connect")
|
self.dispatch("connect")
|
||||||
await server.serve()
|
await server.serve()
|
||||||
@@ -189,7 +281,10 @@ class App(discord.Bot):
|
|||||||
|
|
||||||
@override
|
@override
|
||||||
async def close(self) -> None:
|
async def close(self) -> None:
|
||||||
pass
|
self._closed: bool = True
|
||||||
|
|
||||||
|
await self.http.close()
|
||||||
|
self._ready.clear()
|
||||||
|
|
||||||
@override
|
@override
|
||||||
async def start( # pyright: ignore [reportIncompatibleMethodOverride]
|
async def start( # pyright: ignore [reportIncompatibleMethodOverride]
|
||||||
@@ -199,6 +294,10 @@ class App(discord.Bot):
|
|||||||
uvicorn_options: dict[str, Any] | None = None, # pyright: ignore [reportExplicitAny]
|
uvicorn_options: dict[str, Any] | None = None, # pyright: ignore [reportExplicitAny]
|
||||||
health: bool = True,
|
health: bool = True,
|
||||||
) -> None:
|
) -> None:
|
||||||
|
if not token:
|
||||||
|
raise InvalidCredentialsError("No token provided")
|
||||||
|
if not public_key:
|
||||||
|
raise InvalidCredentialsError("No public key provided")
|
||||||
await self.login(token)
|
await self.login(token)
|
||||||
await self.connect(
|
await self.connect(
|
||||||
token=token,
|
token=token,
|
||||||
|
|||||||
12
src/pycord_rest/errors.py
Normal file
12
src/pycord_rest/errors.py
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Copyright (c) Paillat-dev
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
import discord
|
||||||
|
|
||||||
|
|
||||||
|
class PycordRestError(discord.DiscordException):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class InvalidCredentialsError(PycordRestError):
|
||||||
|
pass
|
||||||
32
src/pycord_rest/models.py
Normal file
32
src/pycord_rest/models.py
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# Copyright (c) Paillat-dev
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
from enum import Enum
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from pydantic import BaseModel
|
||||||
|
|
||||||
|
|
||||||
|
class WebhookType(Enum):
|
||||||
|
PING = 0
|
||||||
|
Event = 1
|
||||||
|
|
||||||
|
|
||||||
|
class EventType(Enum):
|
||||||
|
APPLICATION_AUTHORIZED = "APPLICATION_AUTHORIZED"
|
||||||
|
ENTITLEMENT_CREATE = "ENTITLEMENT_CREATE"
|
||||||
|
QUEST_USER_ENROLLMENT = "QUEST_USER_ENROLLMENT"
|
||||||
|
|
||||||
|
|
||||||
|
class EventBody(BaseModel):
|
||||||
|
type: EventType
|
||||||
|
timestamp: datetime
|
||||||
|
data: dict[str, Any] | None = None # pyright: ignore [reportExplicitAny]
|
||||||
|
|
||||||
|
|
||||||
|
class WebhookEventPayload(BaseModel):
|
||||||
|
version: int
|
||||||
|
application_id: int
|
||||||
|
type: WebhookType
|
||||||
|
event: EventBody | None = None
|
||||||
Reference in New Issue
Block a user