telegrinder 0.4.1__tar.gz → 0.4.2__tar.gz

telegrinder-0.4.2/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,30 @@
+---
+name: "\U0001F41B Bug report \U0001F41B"
+about: "\U0001F41B Reporting a bug. \U0001F41B"
+title: ""
+labels: ["bug"]
+assignees: "luwqz1"
+---
+
+### ⚪️ Checklist ⚪️
+* [ ] ❕ I'm sure this is a **bug** in the **framework** ❕
+* [ ] 🔎 I have searched for **similar** *bugs* in `issues/PRs` 🔍
+* [ ] 🟢 I have the **latest** version of the **framework** installed 🟢
+
+### ✏️ Description ✏️
+<!-- Describe the bug. -->
+_No response_
+
+
+### 🪄 Code example 🪄
+<!--  Provide a minimal example. -->
+```python
+from telegrinder import ...
+```
+
+### 📝 Logs 📝
+<!-- Provide logs/errors to review the issue. -->
+```console
+Traceback (most recent call last):
+File "main.py", line 1, in <module>
+```

telegrinder-0.4.2/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 Telegram chat 💬
+    url: https://t.me/botoforum
+    about: ✏️ You can ask questions about the framework. ✏️

telegrinder-0.4.2/.github/ISSUE_TEMPLATE/new_feat.md

@@ -0,0 +1,24 @@
+---
+name: "\U0001F680 New feature \U0001F680"
+about: "\U0001F680 I want to propose a new feature. \U0001F680"
+title: ""
+labels: ["new_feature"]
+assignees: []
+---
+
+## 🚀 Feature Request 🚀
+
+**✏️ New feature description ✏️**
+<!-- A clear and concise description. -->
+_No response_
+
+
+**🪄 Provide a minimal example 🪄**
+<!-- A small code sample that will demonstrate your feature. -->
+```python
+from telegrinder import ...
+```
+
+**✨ Teachability, Documentation, Adoption ✨**
+<!-- If you can, explain how users will be able to use this and possibly write out a version the docs. -->
+_No response_

telegrinder-0.4.2/.github/actions/setup/action.yaml

@@ -0,0 +1,9 @@
+name: "install uv"
+description: "installs uv using the community action"
+runs:
+  using: composite
+  steps:
+    - name: install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        version: "0.5.20"

telegrinder-0.4.2/.github/dependabot.yaml

@@ -0,0 +1,11 @@
+version: 2
+
+updates:
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-type: "direct"
+    open-pull-requests-limit: 4
+    target-branch: "dev"

telegrinder-0.4.2/.github/pull_request_template.md

@@ -0,0 +1,18 @@
+### ✏️ Description ✏️
+<!--
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
+-->
+_No response_
+
+`🐛 Fixes # (issue)`
+
+### 📍 Type of change 📍
+- [ ] 🐛 Bug fix (non-breaking change which fixes an issue) 🐛
+- [ ] 🚀 New feature (non-breaking change which adds functionality) 🚀
+- [ ] ⚡ Breaking change (fix or feature that would cause existing functionality not to work as expected) ⚡
+- [ ] 📝 This change requires a documentation update 📝
+
+### ⚪️ Checklist ⚪️
+* [ ] 📝 Your code has documentation 📝
+* [ ] 🔧 Your code has tests 🔧
+* [ ] 🪄 Your code has example usage in `/examples` 🪄

telegrinder-0.4.2/.github/workflows/lint_and_test.yml

@@ -0,0 +1,46 @@
+name: Lint and test
+on: [push]
+jobs:
+  lock_file:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: uv lock --locked
+
+  linting:
+    runs-on: ubuntu-22.04
+    needs: [lock_file]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: uvx ruff check .
+
+  type_checking:
+    runs-on: ubuntu-22.04
+    needs: [lock_file]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: uv run basedpyright --level ERROR
+
+  tests:
+    runs-on: ubuntu-22.04
+    needs: [lock_file]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: uv run pytest --cov
+
+  build:
+    runs-on: [ubuntu-22.04]
+    needs: [linting, type_checking, tests]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: uv build
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-artifacts
+          path: dist/

telegrinder-0.4.2/.github/workflows/typegen.yml

@@ -0,0 +1,41 @@
+name: Generating Telegram Bot API types
+
+on:
+  workflow_dispatch: {}
+  schedule:
+    - cron: "0 13 * * *"
+
+jobs:
+  lock_file:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: uv lock --locked
+
+  type_generation:
+    runs-on: ubuntu-22.04
+    needs: [lock_file]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+      - run: uv run typegen
+
+  open_pr:
+    runs-on: ubuntu-22.04
+    needs: [type_generation]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: peter-evans/create-pull-request@v7
+        with:
+          commit-message: >
+            Update Bot API types based on the latest schema changes
+          title: >
+            Update Bot API types based on the latest schema changes
+          body: >
+            This is an automated PR. Please check the diff, and the action logs, to check for any funky behavior.
+          branch: automated/types
+          reviewers: luwqz1
+          assignees: luwqz1
+          labels: automated, types
+          delete-branch: true

telegrinder-0.4.2/.gitignore

@@ -0,0 +1,148 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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
+.idea
+*.iml
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+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/
+
+# Mac OS trash
+.DS_Store
+
+# Test databases
+*.db
+.db
+*.db-shm
+*.db-wal
+
+# pytest
+.pytest_cache
+
+# ruff
+.ruff_cache
+
+.vscode
+local
+
+pyvenv.cfg
+
+.basedpyright

telegrinder-0.4.2/.pre-commit-config.yaml

@@ -0,0 +1,65 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-merge-conflict
+        stages: [ pre-commit, pre-push ]
+      - id: check-ast
+        stages: [ pre-commit ]
+      - id: trailing-whitespace
+        stages: [ pre-commit ]
+      - id: end-of-file-fixer
+        stages: [ pre-commit ]
+
+  - repo: local
+    hooks:
+      - id: lock
+        name: lock
+        description: "Run uv lock"
+        entry: uv lock --locked
+        language: system
+        pass_filenames: false
+        types: [ python ]
+        stages: [ pre-commit ]
+
+      #- id: basedpyright
+      #  name: basedpyright
+      #  description: "Run 'basedpyright' for Python type checking"
+      #  entry: uv run basedpyright --level ERROR
+      #  pass_filenames: false
+      #  language: system
+      #  types: [ python ]
+      #  stages: [ pre-commit ]
+
+      - id: pytest
+        name: pytest
+        description: "Run tests for testing code"
+        entry: uv run pytest
+        language: system
+        pass_filenames: false
+        types: [ python ]
+        stages: [ pre-commit ]
+
+      - id: ruff
+        name: ruff-format
+        description: "Run 'ruff format' for extremely fast Python formatting"
+        entry: uv run ruff format
+        language: system
+        types: [ python ]
+        stages: [ pre-commit ]
+
+      - id: ruff
+        name: ruff-isort
+        description: "Run 'ruff --select I --select F401 --fix' for extremely fast Python sorting imports"
+        entry: uv run ruff check --select I --select F401 --fix
+        language: system
+        types: [ python ]
+        stages: [ pre-commit ]
+
+      - id: ruff
+        name: ruff-check
+        description: "Run 'ruff-format' for extremely fast Python linting"
+        entry: uv run ruff check --fix
+        language: system
+        types: [ python ]
+        stages: [ pre-commit ]

telegrinder-0.4.2/.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+  commands:
+    - pip install mkdocs mkdocs-material mkdocs-redirects
+    - cat mkdocs.yml
+    - mkdocs build --clean --site-dir $READTHEDOCS_OUTPUT/html --config-file mkdocs.yml
+
+mkdocs:
+  configuration: mkdocs.yml

{telegrinder-0.4.1 → telegrinder-0.4.2}/PKG-INFO

@@ -1,35 +1,36 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: telegrinder
-Version: 0.4.1
+Version: 0.4.2
 Summary: Modern visionary telegram bot framework.
+Project-URL: Source, https://github.com/timoniq/telegrinder
+Project-URL: Bug Tracker, https://github.com/timoniq/telegrinder/issues
+Project-URL: Documentation, https://telegrinder.readthedocs.io/en/latest/
+Author-email: timoniq <tesseradecades@mail.ru>
+Maintainer-email: luwqz1 <howluwqz1@gmail.com>
 License: MIT License
-         
-         Copyright (c) 2022-2025 timoniq
-         Copyright (c) 2024-2025 luwqz1
-         
-         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.
-Keywords: asyncio,api schema,async,bot building,bot api,custom rules,telegram,telegram bot api framework,telegrinder framework,middleware,composition,framework,telegrinder,waiter machine
-Author: timoniq
-Author-email: tesseradecades@mail.ru
-Maintainer: luwqz1
-Maintainer-email: howluwqz1@gmail.com
-Requires-Python: >=3.12,<4.0
+        
+        Copyright (c) 2022-2025 timoniq
+        Copyright (c) 2024-2025 luwqz1
+        
+        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.
+License-File: LICENSE
+Keywords: api schema,async,asyncio,bot api,bot building,composition,custom rules,framework,middleware,telegram,telegram bot api framework,telegrinder,telegrinder framework,waiter machine
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -38,27 +39,25 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.12
+Requires-Dist: aiohttp<4.0.0,>=3.11.14
+Requires-Dist: certifi>=2025.1.31
+Requires-Dist: choicelib<0.2.0,>=0.1.5
+Requires-Dist: colorama<0.5.0,>=0.4.6
+Requires-Dist: envparse<0.3.0,>=0.2.0
+Requires-Dist: fntypes<0.2.0,>=0.1.4.post3
+Requires-Dist: msgspec<0.20.0,>=0.19.0
+Requires-Dist: typing-extensions<5.0.0,>=4.12.2
+Requires-Dist: vbml<2.0,>=1.1.post1
 Provides-Extra: all
+Requires-Dist: loguru>=0.7.0; extra == 'all'
+Requires-Dist: uvloop>=0.21.0; extra == 'all'
 Provides-Extra: fast
+Requires-Dist: uvloop>=0.21.0; extra == 'fast'
 Provides-Extra: loguru
+Requires-Dist: loguru>=0.7.0; extra == 'loguru'
 Provides-Extra: uvloop
-Requires-Dist: aiohttp (>=3.11.11,<4.0.0)
-Requires-Dist: certifi (>=2025.1.31)
-Requires-Dist: choicelib (>=0.1.5,<0.2.0)
-Requires-Dist: colorama (>=0.4.6,<0.5.0)
-Requires-Dist: envparse (>=0.2.0,<0.3.0)
-Requires-Dist: fntypes (>=0.1.4.post3,<0.2.0)
-Requires-Dist: loguru (>=0.7.0) ; extra == "all"
-Requires-Dist: loguru (>=0.7.0) ; extra == "loguru"
-Requires-Dist: msgspec (>=0.19.0,<0.20.0)
-Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
-Requires-Dist: uvloop (>=0.21.0) ; extra == "all"
-Requires-Dist: uvloop (>=0.21.0) ; extra == "fast"
-Requires-Dist: uvloop (>=0.21.0) ; extra == "uvloop"
-Requires-Dist: vbml (>=1.1.post1,<2.0)
-Project-URL: Bug Tracker, https://github.com/timoniq/telegrinder/issues
-Project-URL: Documentation, https://telegrinder.readthedocs.io/en/latest/
-Project-URL: Source, https://github.com/timoniq/telegrinder
+Requires-Dist: uvloop>=0.21.0; extra == 'uvloop'
 Description-Content-Type: text/markdown
 
 # Telegrinder
@@ -83,17 +82,26 @@ pip install telegrinder
 ```
 
 Using poetry:
-
 ```console
 poetry add telegrinder
 ```
 
+Using uv:
+
+```console
+uv add telegrinder
+```
+
 Install from github:
 
 ```console
 pip install -U https://github.com/timoniq/telegrinder/archive/dev.zip
 ```
 
+```console
+uv add "telegrinder @ git+https://github.com/timoniq/telegrinder.git@dev"
+```
+
 ```console
 poetry add git+https://github.com/timoniq/telegrinder.git#dev
 ```
@@ -111,7 +119,7 @@ logger.set_level("INFO")
 
 
 @bot.on.message(Text("/start"))
-async def start(message: Message):
+async def start(message: Message) -> None:
     me = (await api.get_me()).unwrap()
     await message.answer(f"Hello, {message.from_user.full_name}! I'm {me.full_name}.")
 
@@ -137,7 +145,7 @@ Copyright © 2024-2025 [luwqz1](https://github.com/luwqz1)
 
 # Contributors
 
+
 <a href="https://github.com/timoniq/telegrinder/graphs/contributors">
  <img src="https://contributors-img.web.app/image?repo=timoniq/telegrinder" />
 </a>
-

telegrinder-0.4.2/contributing.md

@@ -0,0 +1,5 @@
+# Contributing
+
+## For developers
+
+PRs are welcome, feel free to contribute.

telegrinder-0.4.2/docs/api.md

@@ -0,0 +1,58 @@
+# API
+
+API instance is used to make telegram bot api requests.
+
+It is derived from API which guarantees implementation of `request` and `request_raw` methods.
+
+`telegrinder.API` instance is fully typed and implements all the methods provided by telegram bot api.
+
+Initialization:
+
+```python
+from telegrinder import API, Token
+api = API(Token("token"))
+```
+
+## Using typed methods
+
+All methods are in snake case and return a result of model or APIError.
+
+More about results [here](tools/result.md).
+
+```python
+user = (await api.get_me()).unwrap()
+user.first_name
+```
+
+## `.request`
+
+Makes a request with `request_raw`, returns result with parsed data (list, dict or boolean) or APIError.
+
+```python
+result = await api.request("getMe", {})
+result.unwrap()["first_name"]
+```
+
+## `.request_raw`
+
+Makes a request to telegram instance serving at `.request_url`.
+
+Returns result with `msgspec.Raw` data or `APIError`.
+
+```python
+result = await api.request_raw("getMe", {})
+json.loads(result.unwrap())["first_name"]
+```
+
+## APIError
+
+`telegrinder.APIError` contains `code` and `error`
+
+```python
+from telegrinder import Result, APIError, Error
+result: Result[bool, APIError] = get_result()
+
+match result:
+    case Error(err):
+        print(err.code, err.error)
+```