mirror of
https://github.com/Paillat-dev/pycord-rest.git
synced 2026-01-02 09:06:20 +00:00
Compare commits
42 Commits
v0.1.0a6
...
fix/view-c
| Author | SHA1 | Date | |
|---|---|---|---|
| 333bc264d1 | |||
|
|
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 |
6
.github/workflows/publish.yaml
vendored
6
.github/workflows/publish.yaml
vendored
@@ -9,15 +9,15 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
environment: pypi
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: "Install uv"
|
||||
uses: astral-sh/setup-uv@v5
|
||||
uses: astral-sh/setup-uv@v7
|
||||
with:
|
||||
enable-cache: true
|
||||
|
||||
- name: "Set up Python"
|
||||
uses: actions/setup-python@v5
|
||||
uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version-file: "pyproject.toml"
|
||||
|
||||
|
||||
10
.github/workflows/quality.yaml
vendored
10
.github/workflows/quality.yaml
vendored
@@ -9,9 +9,9 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Setup Copywrite
|
||||
uses: hashicorp/setup-copywrite@5e3e8a26d7b9f8a508848ad0a069dfd2f7aa5339
|
||||
uses: hashicorp/setup-copywrite@32f9f1c86f661b8a51100768976a06f1b281a035
|
||||
- name: Check Header Compliance
|
||||
run: copywrite headers --plan --config .copywrite.hcl
|
||||
|
||||
@@ -35,15 +35,15 @@ jobs:
|
||||
name: ${{ matrix.name }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: "Install uv"
|
||||
uses: astral-sh/setup-uv@v5
|
||||
uses: astral-sh/setup-uv@v7
|
||||
with:
|
||||
enable-cache: true
|
||||
|
||||
- name: "Set up Python"
|
||||
uses: actions/setup-python@v5
|
||||
uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version-file: "pyproject.toml"
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ repos:
|
||||
exclude: \.(po|pot|yml|yaml)$
|
||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||
# Ruff version.
|
||||
rev: v0.9.10
|
||||
rev: v0.11.11
|
||||
hooks:
|
||||
# Run the linter.
|
||||
- id: ruff
|
||||
|
||||
45
README.md
45
README.md
@@ -1,18 +1,28 @@
|
||||
<div align="center">
|
||||
<h1>Pycord REST</h1>
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
<!-- badges -->
|
||||
|
||||
[](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)
|
||||
|
||||
<!-- end badges -->
|
||||
|
||||
<!-- short description -->
|
||||
|
||||
A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord
|
||||
and FastAPI.
|
||||
|
||||
<!-- end short description -->
|
||||
|
||||
</div>
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Overview](#overview)
|
||||
@@ -31,6 +41,7 @@ and FastAPI.
|
||||
- [Custom Routes](#custom-routes)
|
||||
- [Configuration](#configuration)
|
||||
- [Limitations](#limitations)
|
||||
- [Getting Help](#getting-help)
|
||||
- [Development](#development)
|
||||
- [Local Testing](#local-testing)
|
||||
- [Contributing](#contributing)
|
||||
@@ -52,12 +63,10 @@ Built on:
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install pycord-rest-bot --prerelease=allow
|
||||
pip install pycord-rest-bot
|
||||
```
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
> [!NOTE]
|
||||
> The package is currently in pre-release.
|
||||
<!-- quick-start -->
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -104,7 +113,7 @@ Unlike traditional WebSocket-based Discord bots, HTTP-based applications:
|
||||
1. Create an application on the
|
||||
[Discord Developer Portal](https://discord.com/developers/applications)
|
||||
2. Copy your public key to verify signatures
|
||||
3. Run your FastAPI server
|
||||
3. Run the Pycord REST app
|
||||
4. Configure the endpoints:
|
||||
|
||||
- **Interactions Endpoint URL** - For slash commands and component interactions
|
||||
@@ -232,6 +241,22 @@ Since Pycord REST doesn't use Discord's WebSocket gateway:
|
||||
- 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
|
||||
|
||||
@@ -21,7 +21,7 @@ class MyView(discord.ui.View):
|
||||
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
||||
super().__init__(*args, **kwargs)
|
||||
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"
|
||||
)
|
||||
)
|
||||
|
||||
@@ -1,17 +1,16 @@
|
||||
[build-system]
|
||||
requires = ["hatchling", "hatch-vcs"]
|
||||
requires = ["hatchling", "hatch-vcs", "hatch-fancy-pypi-readme"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "pycord-rest-bot"
|
||||
dynamic = ["version", "urls"]
|
||||
description = "A discord rest-bot wrapper for pycord"
|
||||
readme = "README.md"
|
||||
dynamic = ["version", "urls", "readme"]
|
||||
description = "A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord and FastAPI"
|
||||
authors = [
|
||||
{ name = "Paillat-dev", email = "me@paillat.dev" }
|
||||
]
|
||||
license = "MIT"
|
||||
requires-python = "==3.12.*"
|
||||
requires-python = ">=3.12, <4.0"
|
||||
classifiers = [
|
||||
"Development Status :: 3 - Alpha",
|
||||
"Intended Audience :: Developers",
|
||||
@@ -25,7 +24,7 @@ keywords = ["discord", "bot", "rest", "pycord"]
|
||||
dependencies = [
|
||||
"fastapi>=0.115.11",
|
||||
"orjson>=3.10.15",
|
||||
"py-cord==2.6.1",
|
||||
"py-cord>=2.7.0rc1",
|
||||
"pynacl>=1.5.0",
|
||||
"uvicorn>=0.34.0",
|
||||
]
|
||||
@@ -47,6 +46,34 @@ version-file = "src/pycord_rest/_version.py"
|
||||
Homepage = "https://github.com/Paillat-dev/pycord-rest"
|
||||
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]
|
||||
name = "pycord-rest-bot"
|
||||
|
||||
@@ -71,7 +98,7 @@ reportUnusedCallResult = false
|
||||
reportAny = false
|
||||
executionEnvironments = [
|
||||
{ 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]
|
||||
|
||||
@@ -1,25 +1,13 @@
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": ["config:recommended"],
|
||||
"baseBranches": ["main"],
|
||||
"labels": ["deps"],
|
||||
"ignorePaths": ["requirements.txt"],
|
||||
"commitMessagePrefix": "⬆️",
|
||||
"commitMessageAction": "Upgrade",
|
||||
"packageRules": [
|
||||
{
|
||||
"updateTypes": ["pin"],
|
||||
"commitMessagePrefix": "📌",
|
||||
"commitMessageAction": "Pin"
|
||||
},
|
||||
{
|
||||
"updateTypes": ["rollback"],
|
||||
"commitMessagePrefix": "⬇️",
|
||||
"commitMessageAction": "Downgrade"
|
||||
},
|
||||
{
|
||||
"matchDatasources": ["pypi"],
|
||||
"addLabels": ["pypi"]
|
||||
}
|
||||
]
|
||||
"extends": [
|
||||
"local>nicebots-xyz/renovate-config",
|
||||
":semanticPrefixFixDepsChoreOthers",
|
||||
":dependencyDashboard"
|
||||
],
|
||||
"forkProcessing": "enabled",
|
||||
"baseBranchPatterns": ["main"],
|
||||
"lockFileMaintenance": {
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
# Copyright (c) Paillat-dev
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
import base64
|
||||
import functools
|
||||
import logging
|
||||
import warnings
|
||||
from collections.abc import Callable, Coroutine
|
||||
from functools import cached_property
|
||||
from typing import Any, Never, override
|
||||
@@ -14,6 +17,7 @@ from fastapi import APIRouter, Depends, FastAPI, HTTPException, Request, Respons
|
||||
from nacl.exceptions import BadSignatureError
|
||||
from nacl.signing import VerifyKey
|
||||
|
||||
from .errors import InvalidCredentialsError
|
||||
from .models import EventType, WebhookEventPayload, WebhookType
|
||||
|
||||
logger = logging.getLogger("pycord.rest")
|
||||
@@ -34,21 +38,38 @@ class ApplicationAuthorizedEvent:
|
||||
)
|
||||
|
||||
|
||||
class PycordRestError(discord.DiscordException):
|
||||
pass
|
||||
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)
|
||||
|
||||
|
||||
class InvalidCredentialsError(PycordRestError):
|
||||
pass
|
||||
return inner
|
||||
|
||||
|
||||
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]
|
||||
self._app: FastAPI = FastAPI(openapi_url=None, docs_url=None, redoc_url=None)
|
||||
self.router: APIRouter = APIRouter()
|
||||
self._app: FastAPI = self._FastAPI(openapi_url=None, docs_url=None, redoc_url=None)
|
||||
self.router: APIRouter = self._APIRouter(prefix=path_prefix)
|
||||
self._public_key: str | None = None
|
||||
|
||||
@property
|
||||
@override
|
||||
@not_supported
|
||||
def latency(self) -> float:
|
||||
return 0.0
|
||||
|
||||
@cached_property
|
||||
def _verify_key(self) -> VerifyKey:
|
||||
if self._public_key is None:
|
||||
@@ -60,23 +81,23 @@ class App(discord.Bot):
|
||||
self._connection._view_store._ViewStore__verify_integrity() # noqa: SLF001 # pyright: ignore [reportUnknownMemberType, reportAttributeAccessIssue, reportPrivateUsage]
|
||||
message_id: int | None = interaction.message and interaction.message.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)
|
||||
)
|
||||
if value is None:
|
||||
return
|
||||
|
||||
view, item = value # pyright: ignore [reportUnknownVariableType]
|
||||
view, item = value
|
||||
item.refresh_state(interaction)
|
||||
|
||||
# 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
|
||||
|
||||
if 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:
|
||||
signature = request.headers["X-Signature-Ed25519"]
|
||||
@@ -247,8 +268,10 @@ class App(discord.Bot):
|
||||
self._app.include_router(self.router)
|
||||
uvicorn_options = uvicorn_options or {}
|
||||
uvicorn_options["log_level"] = uvicorn_options.get("log_level", logging.root.level)
|
||||
config = uvicorn.Config(self._app, **uvicorn_options)
|
||||
server = uvicorn.Server(config)
|
||||
uvicorn_options["server_header"] = uvicorn_options.get("server_header", False)
|
||||
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:
|
||||
self.dispatch("connect")
|
||||
await server.serve()
|
||||
@@ -258,7 +281,10 @@ class App(discord.Bot):
|
||||
|
||||
@override
|
||||
async def close(self) -> None:
|
||||
pass
|
||||
self._closed: bool = True
|
||||
|
||||
await self.http.close()
|
||||
self._ready.clear()
|
||||
|
||||
@override
|
||||
async def start( # pyright: ignore [reportIncompatibleMethodOverride]
|
||||
|
||||
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
|
||||
Reference in New Issue
Block a user