aiogram-webhook 0.0.1__tar.gz

aiogram_webhook-0.0.1/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

aiogram_webhook-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,54 @@
+name: Release & Publish
+
+on: workflow_dispatch
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-release-${{ github.ref_name }}
+      cancel-in-progress: true
+
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - name: 🛎️ Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref_name }}
+          fetch-depth: 0
+
+      - name: 🏷️ Semantic Version Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v10.5.3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions"
+          git_committer_email: "actions@users.noreply.github.com"
+
+      - name: 🐍 Setup uv & venv
+        if: steps.release.outputs.released == 'true'
+        uses: astral-sh/setup-uv@v5
+
+      - name: 📦 Update uv.lock
+        if: steps.release.outputs.released == 'true'
+        run: uv lock
+
+      - name: 🏗️ Build package (sdist & wheel)
+        if: steps.release.outputs.released == 'true'
+        run: uv build --no-sources
+
+      - name: 🚀 Publish | Upload to GitHub Release Assets
+        if: steps.release.outputs.released == 'true'
+        uses: python-semantic-release/publish-action@v10.5.3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}
+
+      - name: 🐍 Publish to PyPI
+        if: steps.release.outputs.released == 'true'
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: uv publish

aiogram_webhook-0.0.1/.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --all-groups
+
+      - name: Run Ruff
+        run: uv run ruff check --output-format=github .
+
+#      - name: Run pytest
+#        run: uv run pytest

aiogram_webhook-0.0.1/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   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:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  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
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

aiogram_webhook-0.0.1/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+<!-- version list -->
+
+## v0.0.1 (2025-12-27)
+
+- Initial Release

aiogram_webhook-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 m-xim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aiogram_webhook-0.0.1/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: aiogram-webhook
+Version: 0.0.1
+Summary: A python library for integrating webhook support with multiple web frameworks in aiogram. Organizes bot operation via webhooks for both single and multi-bot setups.
+Project-URL: Homepage, https://github.com/m-xim/aiogram-webhook
+Project-URL: Repository, https://github.com/m-xim/aiogram-webhook
+Project-URL: Issues, https://github.com/m-xim/aiogram-webhook/issues
+Project-URL: Documentation, https://github.com/m-xim/aiogram-webhook#readme
+Author-email: m-xim <i@m-xim.ru>
+License: MIT
+License-File: LICENSE
+Keywords: aiogram,fastapi,multibot,telegram,webhook
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: aiogram>=3.23.0
+Requires-Dist: yarl>=1.22.0
+Description-Content-Type: text/markdown
+
+# aiogram-webhook
+
+[![PyPI version](https://img.shields.io/pypi/v/aiogram-webhook?color=blue)](https://pypi.org/project/aiogram-webhook)
+[![License](https://img.shields.io/github/license/m-xim/aiogram-webhook.svg)](/LICENSE)
+[![Tests Status](https://github.com/m-xim/aiogram-webhook/actions/workflows/tests.yml/badge.svg)](https://github.com/m-xim/aiogram-webhook/actions)
+[![Release Status](https://github.com/m-xim/aiogram-webhook/actions/workflows/release.yml/badge.svg)](https://github.com/m-xim/aiogram-webhook/actions)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/m-xim/aiogram-webhook)
+
+**aiogram-webhook** is a Python library for seamless webhook integration with multiple web frameworks in aiogram. It enables both single and multi-bot operation via webhooks, with flexible routing and security features.
+
+<br>
+
+## ✨ Features
+
+- 🧱 Modular and extensible webhook engine
+- 🔀 Flexible routing (static and token-based)
+- 🤖 Supports single and multi-bot setups
+- ⚡ FastAPI adapters out of the box
+- 🔒 Security best practices: secret tokens, IP checks
+- 🧩 Easy to extend with custom adapters and routing
+
+## 🚀 Installation
+
+```bash
+uv add aiogram-webhook
+# or
+pip install aiogram-webhook
+```
+
+## ⚡ Quick Start
+
+### Single Bot Example (FastAPI)
+```python
+import uvicorn
+from contextlib import asynccontextmanager
+from fastapi import FastAPI
+from aiogram import Bot, Dispatcher, Router
+from aiogram.filters import CommandStart
+from aiogram.types import Message
+from aiogram_webhook import SimpleEngine, FastApiWebAdapter
+from aiogram_webhook.routing import PathRouting
+
+router = Router()
+
+@router.message(CommandStart())
+async def start(message: Message):
+    await message.answer("OK")
+
+dispatcher = Dispatcher()
+dispatcher.include_router(router)
+bot = Bot("BOT_TOKEN_HERE")
+
+engine = SimpleEngine(
+    dispatcher,
+    bot,
+    web_adapter=FastApiWebAdapter(),
+    routing=PathRouting(url="/webhook"),
+)
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    engine.register(app)
+    await engine.set_webhook(
+        drop_pending_updates=True,
+        allowed_updates=("message", "callback_query"),
+    )
+    await engine.on_startup()
+    yield
+    await engine.on_shutdown()
+
+app = FastAPI(lifespan=lifespan)
+
+if __name__ == "__main__":
+    uvicorn.run("main:app", host="0.0.0.0", port=8080)
+```
+
+### Multi-Bot Example (FastAPI)
+Each bot is configured in Telegram with its own webhook URL: `https://example.com/webhook/<BOT_TOKEN>`
+
+```python
+from aiogram import Dispatcher
+from aiogram.client.default import DefaultBotProperties
+from aiogram_webhook import TokenEngine, FastApiWebAdapter
+from aiogram_webhook.routing import PathRouting
+
+dispatcher = Dispatcher()
+engine = TokenEngine(
+    dispatcher,
+    web_adapter=FastApiWebAdapter(),
+    routing=PathRouting(url="/webhook/{bot_token}", param="bot_token"),
+    bot_settings={
+        "default": DefaultBotProperties(parse_mode="HTML"),
+    },
+)
+```
+
+Usage is the same:
+```python
+engine.register(app)
+await engine.set_webhook(...)
+await engine.on_startup()
+await engine.on_shutdown()
+```
+
+## 🛣️ Routing
+
+`PathRouting` defines where Telegram sends updates:
+
+- **Static path:**
+    ```python
+  PathRouting(url="/webhook")
+  ```
+- **Token-based path:**
+  ```python
+  PathRouting(url="/webhook/{bot_token}", param="bot_token")
+  ```
+
+## 🛡️ Security
+writings...

aiogram_webhook-0.0.1/README.md

@@ -0,0 +1,119 @@
+# aiogram-webhook
+
+[![PyPI version](https://img.shields.io/pypi/v/aiogram-webhook?color=blue)](https://pypi.org/project/aiogram-webhook)
+[![License](https://img.shields.io/github/license/m-xim/aiogram-webhook.svg)](/LICENSE)
+[![Tests Status](https://github.com/m-xim/aiogram-webhook/actions/workflows/tests.yml/badge.svg)](https://github.com/m-xim/aiogram-webhook/actions)
+[![Release Status](https://github.com/m-xim/aiogram-webhook/actions/workflows/release.yml/badge.svg)](https://github.com/m-xim/aiogram-webhook/actions)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/m-xim/aiogram-webhook)
+
+**aiogram-webhook** is a Python library for seamless webhook integration with multiple web frameworks in aiogram. It enables both single and multi-bot operation via webhooks, with flexible routing and security features.
+
+<br>
+
+## ✨ Features
+
+- 🧱 Modular and extensible webhook engine
+- 🔀 Flexible routing (static and token-based)
+- 🤖 Supports single and multi-bot setups
+- ⚡ FastAPI adapters out of the box
+- 🔒 Security best practices: secret tokens, IP checks
+- 🧩 Easy to extend with custom adapters and routing
+
+## 🚀 Installation
+
+```bash
+uv add aiogram-webhook
+# or
+pip install aiogram-webhook
+```
+
+## ⚡ Quick Start
+
+### Single Bot Example (FastAPI)
+```python
+import uvicorn
+from contextlib import asynccontextmanager
+from fastapi import FastAPI
+from aiogram import Bot, Dispatcher, Router
+from aiogram.filters import CommandStart
+from aiogram.types import Message
+from aiogram_webhook import SimpleEngine, FastApiWebAdapter
+from aiogram_webhook.routing import PathRouting
+
+router = Router()
+
+@router.message(CommandStart())
+async def start(message: Message):
+    await message.answer("OK")
+
+dispatcher = Dispatcher()
+dispatcher.include_router(router)
+bot = Bot("BOT_TOKEN_HERE")
+
+engine = SimpleEngine(
+    dispatcher,
+    bot,
+    web_adapter=FastApiWebAdapter(),
+    routing=PathRouting(url="/webhook"),
+)
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    engine.register(app)
+    await engine.set_webhook(
+        drop_pending_updates=True,
+        allowed_updates=("message", "callback_query"),
+    )
+    await engine.on_startup()
+    yield
+    await engine.on_shutdown()
+
+app = FastAPI(lifespan=lifespan)
+
+if __name__ == "__main__":
+    uvicorn.run("main:app", host="0.0.0.0", port=8080)
+```
+
+### Multi-Bot Example (FastAPI)
+Each bot is configured in Telegram with its own webhook URL: `https://example.com/webhook/<BOT_TOKEN>`
+
+```python
+from aiogram import Dispatcher
+from aiogram.client.default import DefaultBotProperties
+from aiogram_webhook import TokenEngine, FastApiWebAdapter
+from aiogram_webhook.routing import PathRouting
+
+dispatcher = Dispatcher()
+engine = TokenEngine(
+    dispatcher,
+    web_adapter=FastApiWebAdapter(),
+    routing=PathRouting(url="/webhook/{bot_token}", param="bot_token"),
+    bot_settings={
+        "default": DefaultBotProperties(parse_mode="HTML"),
+    },
+)
+```
+
+Usage is the same:
+```python
+engine.register(app)
+await engine.set_webhook(...)
+await engine.on_startup()
+await engine.on_shutdown()
+```
+
+## 🛣️ Routing
+
+`PathRouting` defines where Telegram sends updates:
+
+- **Static path:**
+    ```python
+  PathRouting(url="/webhook")
+  ```
+- **Token-based path:**
+  ```python
+  PathRouting(url="/webhook/{bot_token}", param="bot_token")
+  ```
+
+## 🛡️ Security
+writings...

aiogram_webhook-0.0.1/aiogram_webhook/__init__.py

@@ -0,0 +1,12 @@
+from aiogram_webhook.adapters.base import WebAdapter
+from aiogram_webhook.engines.simple import SimpleEngine
+from aiogram_webhook.engines.token import TokenEngine
+
+__all__ = ["SimpleEngine", "TokenEngine", "WebAdapter"]
+
+try:
+    from aiogram_webhook.adapters.fastapi import FastApiWebAdapter  # noqa: F401
+
+    __all__.insert(0, "FastApiWebAdapter")
+except ImportError:
+    pass

aiogram_webhook-0.0.1/aiogram_webhook/adapters/base.py

@@ -0,0 +1,67 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from collections.abc import Awaitable, Callable
+    from ipaddress import IPv4Address, IPv6Address
+
+
+@dataclass(slots=True)
+class BoundRequest(ABC):
+    """
+    Abstract base class for a request bound to a web adapter.
+
+    Provides interface for extracting data from incoming requests and generating responses.
+    """
+
+    request: Any
+    adapter: WebAdapter
+
+    @abstractmethod
+    async def json(self) -> dict[str, Any]:
+        raise NotImplementedError
+
+    @abstractmethod
+    def header(self, name: str) -> Any | None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def query_param(self, name: str) -> Any | None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def path_param(self, name: str) -> Any | None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def ip(self) -> IPv4Address | IPv6Address | str | None:
+        raise NotImplementedError
+
+    def secret_token(self) -> str | None:
+        return self.header(self.adapter.secret_header)
+
+    @abstractmethod
+    def json_response(self, status: int, payload: dict[str, Any]) -> Any:
+        raise NotImplementedError
+
+
+@dataclass
+class WebAdapter(ABC):
+    """
+    Abstract base class for web framework adapters.
+
+    Provides interface for binding requests and registering webhook handlers.
+    """
+
+    secret_header: str = "x-telegram-bot-api-secret-token"  # noqa: S105
+
+    @abstractmethod
+    def bind(self, request: Any) -> BoundRequest:
+        raise NotImplementedError
+
+    @abstractmethod
+    def register(self, app: Any, path: str, handler: Callable[[BoundRequest], Awaitable[Any]]) -> None:
+        raise NotImplementedError