telegrinder 0.4.2__tar.gz → 0.5.0__tar.gz

telegrinder-0.5.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

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

@@ -0,0 +1,23 @@
+---
+name: "\U0001F41B Bug report \U0001F41B"
+about: "Reporting a bug."
+title: "bug: "
+labels: ["bug"]
+assignees: []
+---
+
+**bug description:**
+...
+
+**code:**
+<!--  Provide a minimal example to reproduce -->
+```python
+import telegrinder
+```
+
+**logs:**
+<!-- Provide logs/errors if applicable-->
+```console
+Traceback (most recent call last):
+File "main.py", line 1, in <module>
+```

{telegrinder-0.4.2 → telegrinder-0.5.0}/.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
-blank_issues_enabled: false
+blank_issues_enabled: true
 contact_links:
   - name: 💬 Telegram chat 💬
     url: https://t.me/botoforum

telegrinder-0.5.0/.github/ISSUE_TEMPLATE/feat_request.md

@@ -0,0 +1,16 @@
+---
+name: "\U0001F680 Feature request \U0001F680"
+about: "Creating a feature request."
+title: "feature: "
+labels: ["feature request"]
+assignees: []
+---
+
+**feature description:**
+...
+
+**code:**
+<!-- A small code sample that will demonstrate your feature. -->
+```python
+from telegrinder import MyFeature
+```

telegrinder-0.5.0/.github/actions/install-dependencies/action.yml

@@ -0,0 +1,21 @@
+name: Install uv and dependencies
+
+inputs:
+  python-version:
+    description: "Python version."
+    required: false
+    default: "3.12"
+
+runs:
+  using: composite
+  steps:
+    - uses: hynek/setup-cached-uv@v2
+      with:
+        cache-suffix: -${{ inputs.python-version }}-cache
+        cache-dependency-path: "**/uv.lock"
+
+    - name: "Install dependencies"
+      run: |
+        uv venv --python ${{ inputs.python-version }}
+        uv sync --all-groups --dev
+      shell: bash

telegrinder-0.5.0/.github/workflows/ci.yml

@@ -0,0 +1,85 @@
+name: CI
+
+'on':
+  workflow_call:
+    inputs:
+      os:
+        description: "Operating system"
+        required: true
+        type: string
+      python-version:
+        description: "Python version"
+        required: true
+        type: string
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  lock-file:
+    name: "Lock uv"
+    runs-on: ${{ inputs.os }}
+    steps:
+      - uses: asottile/workflows/.github/actions/fast-checkout@v1.8.1
+
+      - uses: ./.github/actions/install-dependencies
+        with:
+          python-version: ${{ inputs.python-version }}
+
+      - run: uv lock --locked
+
+  linting:
+    name: "Linting"
+    runs-on: ${{ inputs.os }}
+    needs: lock-file
+    steps:
+      - uses: asottile/workflows/.github/actions/fast-checkout@v1.8.1
+
+      - uses: ./.github/actions/install-dependencies
+        with:
+          python-version: ${{ inputs.python-version }}
+
+      - name: Load ruff cache
+        id: cached-ruff
+        uses: actions/cache@v4
+        with:
+          key: ruff-${{ inputs.python-version }}-${{ runner.os }}-${{ hashFiles('pyproject.toml') }}
+          path: .ruff_cache
+
+      - name: "Run ruff"
+        run: uvx ruff check .
+
+  type-checking:
+    name: "Type-checking"
+    runs-on: ${{ inputs.os }}
+    needs: lock-file
+    steps:
+      - uses: asottile/workflows/.github/actions/fast-checkout@v1.8.1
+
+      - uses: ./.github/actions/install-dependencies
+        with:
+          python-version: ${{ inputs.python-version }}
+
+      - run: uv run basedpyright --level ERROR
+
+  tests:
+    name: "Testing"
+    runs-on: ${{ inputs.os }}
+    needs: lock-file
+    steps:
+      - uses: asottile/workflows/.github/actions/fast-checkout@v1.8.1
+
+      - uses: ./.github/actions/install-dependencies
+        with:
+          python-version: ${{ inputs.python-version }}
+
+      - name: Load pytest cache
+        id: cached-pytest
+        uses: actions/cache@v4
+        with:
+          key: pytest-${{ inputs.python-version }}-${{ runner.os }}
+          path: .pytest_cache
+
+      - name: "Run pytest"
+        run: uv run pytest --cov

telegrinder-0.5.0/.github/workflows/pull_request.yml

@@ -0,0 +1,40 @@
+name: PR
+
+'on':
+  pull_request:
+    branches:
+    - tba
+    - dev
+    - main
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  pre-commit:
+    name: "Run pre-commit"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: asottile/workflows/.github/actions/fast-checkout@v1.8.1
+
+      - name: Install uv and dependencies
+        uses: ./.github/actions/install-dependencies
+        with:
+          python-version: "3.13"
+
+      - name: Load pre-commit cache
+        id: cache-pre-commit
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-pre-commit
+        with:
+          key: ${{ env.cache-name }}-${{ hashFiles('**/.pre-commit-config.yaml', '~/.cache/pre-commit/*') }}
+          path: ~/.cache/pre-commit
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --all-files --color=always
+
+      - uses: pre-commit/action@v3.0.1
+      - uses: pre-commit-ci/lite-action@v1.1.0
+        if: always()

telegrinder-0.5.0/.github/workflows/push.yml

@@ -0,0 +1,28 @@
+name: Push
+
+'on':
+  push:
+    branches:
+      - dev
+      - main
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  ci:
+    name: "CI (Push)"
+    strategy:
+      matrix:
+        python-version:
+          - "3.12"
+          - "3.13"
+        os:
+          - ubuntu-latest
+          - windows-latest
+
+    uses: ./.github/workflows/ci.yml
+    with:
+      os: ${{ matrix.os }}
+      python-version: ${{ matrix.python-version }}

telegrinder-0.5.0/.github/workflows/release.yml

@@ -0,0 +1,53 @@
+name: Release to PyPI
+
+'on':
+  release:
+    types:
+      - created
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+    name: "Build distribution"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: asottile/workflows/.github/actions/fast-checkout@v1.8.1
+
+      - uses: ./.github/actions/install-dependencies
+        with:
+          python-version: "3.13"
+
+      - name: "Build distribution"
+        run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: release-dist
+          path: dist/
+
+  pypi-publish:
+    name: "Publish to PyPI"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: asottile/workflows/.github/actions/fast-checkout@v1.8.1
+
+      - name: Download artifact with distribution
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dist
+          path: dist/
+
+      - name: Release distribution
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.event.release.tag_name }}
+          files: dist/
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

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

@@ -0,0 +1,49 @@
+name: Telegram Bot API schema
+
+on:
+  workflow_dispatch: {}
+  schedule:
+    - cron: "0 16 * * *"
+
+jobs:
+  lock-file:
+    name: "Lock uv"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/install-dependencies
+        with:
+          python-version: "3.13"
+
+      - run: uv lock --locked
+
+  generation:
+    name: "TBA schema generation"
+    runs-on: ubuntu-latest
+    needs: lock-file
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/install-dependencies
+        with:
+          python-version: "3.13"
+
+      - name: "Run generator"
+        run: uv run typegen
+
+      - name: "Create PR"
+        uses: peter-evans/create-pull-request@v7
+        with:
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+          commit-message: >
+            types: Telegram Bot API schema changes
+          title: >
+            Update Telegram Bot API to the latest schema
+          body: >
+            This is an automated PR. Please check the diff, and the action logs, to check for any funky behavior.
+          branch: automated/tba
+          reviewers: luwqz1
+          assignees: luwqz1
+          labels: automated, TBA
+          delete-branch: true

{telegrinder-0.4.2 → telegrinder-0.5.0}/.pre-commit-config.yaml

@@ -13,8 +13,8 @@ repos:
 
   - repo: local
     hooks:
-      - id: lock
-        name: lock
+      - id: uv
+        name: uv-lock
         description: "Run uv lock"
         entry: uv lock --locked
         language: system
@@ -22,43 +22,51 @@ repos:
         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: 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
+        entry: uv run pytest tests
         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
+        name: ruff-isort
+        description: "Run 'ruff check --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-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
+        name: ruff-sortall
+        description: "Run 'ruff check --select RUF022 --fix' for extremely fast Python sorting dunder alls"
+        entry: uv run ruff check --select RUF022 --fix
+        language: system
+        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-check
-        description: "Run 'ruff-format' for extremely fast Python linting"
+        description: "Run 'ruff check --fix' for extremely fast Python linting"
         entry: uv run ruff check --fix
         language: system
         types: [ python ]

{telegrinder-0.4.2 → telegrinder-0.5.0}/LICENSE

@@ -1,7 +1,7 @@
 MIT License
 
-Copyright (c) 2022-2025 timoniq
-Copyright (c) 2024-2025 luwqz1
+Copyright (c) 2022 timoniq
+Copyright (c) 2024 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

telegrinder-0.5.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: telegrinder
+Version: 0.5.0
+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://github.com/timoniq/telegrinder/blob/dev/docs/index.md
+Author-email: timoniq <tesseradecades@mail.ru>
+Maintainer-email: luwqz1 <howluwqz1@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2022 timoniq
+        Copyright (c) 2024 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,custom rules,framework,middleware,nodes,telegram,telegram bot api framework,telegrinder,telegrinder framework,waiter machine
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+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: aiodns<4.0.0,>=3.5.0
+Requires-Dist: aiohttp<4.0.0,>=3.12.13
+Requires-Dist: certifi<2026.0.0,>=2025.6.15
+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
+Requires-Dist: msgspec<0.20.0,>=0.19.0
+Requires-Dist: typing-extensions<5.0.0,>=4.14.1
+Requires-Dist: vbml<2.0,>=1.1.post1
+Provides-Extra: brotli
+Requires-Dist: brotli; extra == 'brotli'
+Provides-Extra: loguru
+Requires-Dist: loguru; extra == 'loguru'
+Provides-Extra: socks
+Requires-Dist: aiohttp-socks; extra == 'socks'
+Provides-Extra: structlog
+Requires-Dist: structlog; extra == 'structlog'
+Provides-Extra: uvloop
+Requires-Dist: uvloop; (sys_platform == 'darwin' or sys_platform == 'linux') and extra == 'uvloop'
+Requires-Dist: winloop; (sys_platform == 'cli' or sys_platform == 'cygwin' or sys_platform == 'win32') and extra == 'uvloop'
+Description-Content-Type: text/markdown
+
+<p>
+  <a href="https://github.com/timoniq/telegrinder">
+    <img width="200px" height="145px" alt="Telegrinder" src="https://github.com/timoniq/telegrinder/blob/main/docs/logo.jpg">
+  </a>
+</p>
+
+</p>
+<h1>
+  telegrinder
+</h1>
+
+<p>
+— effective and reliable telegram bot building.
+</p>
+
+<p>
+  <a href="#contributors"><img alt="Still in development" src="https://img.shields.io/badge/Still_in_development-E3956B?logo=textpattern&logoColor=fff&style=flat-square&color=black"></img></a>
+  <a href="#license"><img alt="GitHub License" src="https://img.shields.io/github/license/timoniq/telegrinder.svg?color=lightGreen&labelColor=black&style=flat-square"></img></a>
+  <a href="https://docs.astral.sh/ruff/"><img alt="Code Style" src="https://img.shields.io/badge/code_style-Ruff-D7FF64?logo=ruff&logoColor=fff&style=flat-square&labelColor=black"></img></a>
+  <a href="https://docs.basedpyright.com/latest/"><img alt="Type Checker" src="https://img.shields.io/badge/types-basedpyright-black?logo=python&color=%23FBCA04&logoColor=edb641&labelColor=black&style=flat-square"></img></a>
+  <a href="https://pypi.org/project/telegrinder/"><img alt="Python versions" src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Ftimoniq%2Ftelegrinder%2Frefs%2Fheads%2Fmain%2Fpyproject.toml&style=flat-square&logo=python&logoColor=fff&labelColor=black"></img></a>
+  <a href="https://core.telegram.org/bots/api"><img alt="Telegram Bot API Version" src="https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Ftimoniq%2Ftelegrinder%2Frefs%2Fheads%2Fmain%2Ftypegen%2Fconfig.toml&query=%24.telegram-bot-api.version&style=flat-square&logo=telegram&label=Telegram%20API&labelColor=black&color=%23FBCA04"></img></a>
+</p>
+
+
+* Type hinted
+* Customizable and extensible
+* Ready to use scenarios and rules
+* Fast models built on [msgspec](https://github.com/jcrist/msgspec)
+* Both low-level and high-level API
+
+
+Basic example:
+
+```python
+from telegrinder import API, Message, Telegrinder, Token
+from telegrinder.modules import logger
+from telegrinder.rules import Text
+
+logger.set_level("INFO")
+api = API(token=Token("123:token"))
+bot = Telegrinder(api)
+
+
+@bot.on.message(Text("/start"))
+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}.")
+
+
+bot.run_forever()
+```
+
+# Getting started
+
+Install using pip, uv or poetry:
+
+  <a href="https://pypi.org/project/telegrinder/"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/telegrinder.svg?labelColor=black&style=flat-square&logo=pypi"></img></a>
+
+```console
+uv add telegrinder
+poetry add telegrinder
+pip install telegrinder
+```
+
+Or install from source (unstable):
+
+  <a href="https://github.com/timoniq/telegrinder/actions/workflows/push.yml"><img alt="GitHub CI" src="https://img.shields.io/github/actions/workflow/status/timoniq/telegrinder/push.yml?branch=main&style=flat-square&labelColor=black&label=CI&logo=github"></img></a>
+
+```console
+uv add "telegrinder @ git+https://github.com/timoniq/telegrinder@dev"
+poetry add git+https://github.com/timoniq/telegrinder.git#dev
+pip install git+https://github.com/timoniq/telegrinder/archive/dev.zip
+```
+
+# Documentation
+
+[Tutorial](/docs/tutorial/en/0_tutorial.md)
+
+# Community
+
+Join our [telegram forum](https://t.me/botoforum).
+
+# License
+
+Telegrinder is [MIT licensed](./LICENSE)\
+Copyright © 2022 [timoniq](https://github.com/timoniq)\
+Copyright © 2024 [luwqz1](https://github.com/luwqz1)
+
+# Contributors
+
+[How to contribute](https://github.com/timoniq/telegrinder/blob/main/contributing.md)
+
+
+<a href="https://github.com/timoniq/telegrinder/graphs/contributors">
+ <img src="https://contributors-img.web.app/image?repo=timoniq/telegrinder" />
+</a>

telegrinder-0.5.0/docs/community_links.md

@@ -0,0 +1,11 @@
+# Telegram
+
+Feel free to add more community links if they are based on telegrinder framework
+
+## EN
+
+* [@botoforum](https://t.me/botoforum) - Our main official chat for mixed topics [multiple frameworks and dependency utilities: fntypes, etc] and cozy vibe
+
+## RU
+
+* [@botoforum](https://t.me/botoforum) - Наш основной официальный форум по смешанным темам [несколько фреймворков и их авторские депенденси: fntypes и т.д.]. chill