obervinov / telegram-package Goto Github PK

This is an additional implementation compared to the telebot module. This module is designed for quick initialization, authorization and rendering of various buttons/widgets for telegram bots.

License: MIT License

Python 96.09% HCL 3.91%

module poetry poetry-python python-module python3 telebot telegram-bot

telegram-package's Issues

Fix badge with tests in README.md

Update workflows for this module: tests, checks, dependencies and create release

Bump the templates of workflow to v1.0.4
Remove this rule to run Tests and Checks in main branch
Replace the old tasks with these in Tests and Checks (added verify package and verify changelog)

jobs:
  pylint:
    uses: obervinov/_templates/.github/workflows/[email protected]
  verify-package:
    uses: obervinov/_templates/.github/workflows/[email protected]
  verify-changelog:
    uses: obervinov/_templates/.github/workflows/[email protected]
  pytest:
    uses: obervinov/_templates/.github/workflows/[email protected]

Completely replace the contents of the Create Release workflow with this body

name: Create GitHub Release

on:
  workflow_run:
    workflows: ["Tests and Checks"]
    branches: [main]
    types: 
      - completed
  push:
    branches: [main]
    paths: ['users/**']

jobs:
  create-release:
    uses: obervinov/_templates/.github/workflows/[email protected]

Add more useful methods for typical bots

send_styled_message with using https://github.com/obervinov/messages-package to send unified and formatted messages
launch_bot start pulling the message with logging and exceptions

Update documentation: PR template

Add in PR template **full changelog**: https://github.com/obervinov/_templates/compare/1...2 by @ obervinov https://github.com/obervinov/_templates/pull/1

Add class parameters for exception handling

https://github.com/eternnoir/pyTelegramBotAPI/tree/master/telebot

2023-11-20 19:44:02 [2023-11-20 15:44:02,399] ERROR [TeleBot.__threaded_polling:1085] Exception traceback:
2023-11-20 19:44:02 Traceback (most recent call last):
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/.local/lib/python3.10/site-packages/telebot/__init__.py", line 1074, in __threaded_polling
2023-11-20 19:44:02     self.worker_pool.raise_exceptions()
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/.local/lib/python3.10/site-packages/telebot/util.py", line 147, in raise_exceptions
2023-11-20 19:44:02     raise self.exception_info
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/.local/lib/python3.10/site-packages/telebot/util.py", line 90, in run
2023-11-20 19:44:02     task(*args, **kwargs)
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/.local/lib/python3.10/site-packages/telebot/__init__.py", line 6770, in _run_middlewares_and_handler
2023-11-20 19:44:02     result = handler['function'](message)
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/app/bot.py", line 94, in start_command
2023-11-20 19:44:02     reject_message(message=message)
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/app/bot.py", line 253, in reject_message
2023-11-20 19:44:02     bot.send_message(
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/.local/lib/python3.10/site-packages/telebot/__init__.py", line 1549, in send_message
2023-11-20 19:44:02     apihelper.send_message(
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/.local/lib/python3.10/site-packages/telebot/apihelper.py", line 264, in send_message
2023-11-20 19:44:02     return _make_request(token, method_url, params=payload, method='post')
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/.local/lib/python3.10/site-packages/telebot/apihelper.py", line 162, in _make_request
2023-11-20 19:44:02     json_result = _check_result(method_name, result)
2023-11-20 19:44:02   File "/home/pyinstabot-downloader/.local/lib/python3.10/site-packages/telebot/apihelper.py", line 189, in _check_result
2023-11-20 19:44:02     raise ApiTelegramException(method_name, result, result_json)
2023-11-20 19:44:02 telebot.apihelper.ApiTelegramException: A request to the Telegram API was unsuccessful. Error code: 403. Description: Forbidden: bot was blocked by the user

Change the order of changes by sections in `CHANGELOG.md`

Typo

## v1.1.3 - 2023-06-20
### What's Changed
**Full Changelog**: https://github.com/obervinov/telegram-package/compare/v1.1.2...v1.1.3 by @obervinov in https://github.com/obervinov/telegram-package/pull/18
#### 🐛 Bug Fixes
* [Fix badge with tests in README.md](https://github.com/obervinov/telegram-package/issues/15)
* [Bump vault-package to v2.0.1](https://github.com/obervinov/telegram-package/issues/17)
#### 🚀 Features
* [Fix the error that caused the workflow create_release to run twice - at pr/main](https://github.com/obervinov/telegram-package/issues/16)

Correct

## v1.1.3 - 2023-06-20
### What's Changed
**Full Changelog**: https://github.com/obervinov/telegram-package/compare/v1.1.2...v1.1.3 by @obervinov in https://github.com/obervinov/telegram-package/pull/18
#### 🐛 Bug Fixes
* [Fix badge with tests in README.md](https://github.com/obervinov/telegram-package/issues/15)
* [Fix the error that caused the workflow create_release to run twice - at pr/main](https://github.com/obervinov/telegram-package/issues/16)
#### 🚀 Features
* [Bump vault-package to v2.0.1](https://github.com/obervinov/telegram-package/issues/17)

Add support for the new version of the vault-package:v2.0.0

Add support for the new version of the module https://github.com/obervinov/vault-package/releases/tag/v2.0.0

Dependency graph does not work correctly, sort it out and fix it network/dependencies

Fix the error that caused the workflow `create_release` to run twice - at pr/main

Delete a block in tests if "name" == "main"

Delete a block in tests if "name" == "main" they are not actually used (pytest runs the functions itself)

Bump `vault-package` to `v2.0.1`

https://github.com/obervinov/vault-package/releases/tag/v2.0.1

Fix work with transit dependencies in setup.py

fix install_requires

    install_requires=[
        'logger @ git+https://github.com/obervinov/[email protected]',
        'vault @ git+https://github.com/obervinov/[email protected]',
    ]

remove dependency_links
fix requirements.txt

logger @ git+https://github.com/obervinov/[email protected]
vault @ git+https://github.com/obervinov/[email protected]

update topics in classifiers

    classifiers=[
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3.10",
        "Operating System :: OS Independent",
        "Intended Audience :: Developers",
        "Topic :: Software Development"
    ]

Merge all workflows to single file

for example

name: Test, Build and create relese

on:
  push:
    branches:    
      - '*'
      - '*/*'
      - '**'

env:
  PROJECT_DESCRIPTION: "This project is a telegram bot that allows you to create backups of content from your Instagram profile to Dropbox or Mega clouds, as well as in the local file system."


jobs:
  pylint:
    uses: obervinov/_templates/.github/workflows/[email protected]
  verify-changelog:
    uses: obervinov/_templates/.github/workflows/[email protected]
  pytest:
    uses: obervinov/_templates/.github/workflows/[email protected]
  build-release:
    uses: obervinov/_templates/.github/workflows/build.docker.yml@release/v1.0.5
    needs: [pylint, verify-changelog, pytest]

Fix documentation

https://github.com/obervinov/telegram-package/blob/main/README.md?plain=1#L93-L100
telegram_bot.create_inline_buttons does not exist
correct

        reply_markup = telegram.create_inline_markup(
            names=constants.TELEGRAM_STARTUP_BUTTONS,
            size=2
        )

Bump telebot dependency version to 4.12.0

https://pypi.org/project/pyTelegramBotAPI/

Fix install_requires and dependency_links in setup.py

example

"""
This module is necessary to distribute and install the written module via pip
"""
from setuptools import setup

with open('README.md', 'r', encoding='utf8') as readme:
    readme_content = readme.read()
with open('CHANGELOG.md', 'r', encoding='utf8') as changelog:
    changelog_content = changelog.read()

setup(
    name='users',
    version='1.0.3',
    license='MIT',
    description=(
        "This module contains classes and functions for implementing"
        "the simplest authorization for telegram bots"
    ),
    py_modules=["users"],
    package_dir={'': 'users'},
    author='Oleg Bervinov',
    author_email='[email protected]',
    long_description=(f"{readme_content}""\n\n"f"{changelog_content}"),
    long_description_content_type="text/markdown",
    url='https://github.com/obervinov/users-package',
    include_package_data=True,
    classifiers=[
        "License :: OSI Approved :: MIT License",
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
        'Programming Language :: Python :: 3.10',
        'Programming Language :: Python :: 3.11',
        'Operating System :: OS Independent'
    ],
    keywords=['users', 'authentication'],
    install_requires=[
        'logger @ https://github.com/obervinov/logger-package/tarball/v1.0.1#egg=logger-1.0.1',
        'vault @ https://github.com/obervinov/vault-package/tarball/v2.0.0#egg=vault-2.0.0',
    ],
    dependency_links=[
        'https://github.com/obervinov/logger-package/tarball/v1.0.1#egg=logger-1.0.1'
        'https://github.com/obervinov/vault-package/tarball/v2.0.0#egg=vault-2.0.0'
    ]
)

Migration from pip to poetry

https://github.com/marketplace/actions/python-poetry-action
https://python-poetry.org

remove setup.py
set the pyproject.toml file to the form https://github.com/obervinov/messages-package/blob/main/pyproject.toml
switch dependabot to poetry
update workflows from https://github.com/obervinov/messages-package/tree/main/.github/workflows

Add default size in method parameter

https://github.com/obervinov/telegram-package/blob/main/telegram/telegram.py#L42

    def create_inline_markup(
        self,
        names: list = None,
        size: int = 3
    ) -> telebot.types.InlineKeyboardMarkup:

Add support environment variable `TELEGRAM_BOT_NAME`

Rewrite tests for this module

https://docs.pytest.org/en/7 .2.x/
https://realpython.com/pytest-python-testing/

and explore the possibilities of using the vault service without the mock

obervinov / telegram-package Goto Github PK

telegram-package's People

Contributors

Watchers

telegram-package's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs