maxibot 1.0.3__tar.gz

maxibot-1.0.3/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: maxibot
+Version: 1.0.3
+Summary: Library for build bot in MAX
+Project-URL: Homepage, https://github.com/mrProduktivnyy/maxibot
+Project-URL: Documentation, https://github.com/mrProduktivnyy/maxibot/tree/main/maxibot/docs
+Project-URL: Repository, https://github.com/mrProduktivnyy/maxibot
+Project-URL: Issues, https://github.com/mrProduktivnyy/maxibot/issues
+Keywords: max,bot,api,tools
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests==2.32.5
+
+[![PyPi Package Version](https://img.shields.io/pypi/v/maxibot.svg)](https://pypi.python.org/pypi/maxibot)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/maxibot.svg)](https://pypi.python.org/pypi/maxibot)
+[![Documentation Status](https://img.shields.io/badge/docs-passing-green)](https://github.com/mrProduktivnyy/maxibot/tree/main/maxibot/docs)
+[![PyPi downloads](https://img.shields.io/pypi/dm/maxibot.svg)](https://pypi.org/project/maxibot/)
+[![PyPi status](https://img.shields.io/pypi/status/maxibot.svg?style=flat-square)](https://pypi.python.org/pypi/maxibot)
+
+## Быстрый старт
+Необходимо установить библиотеку  
+```sh
+pip install maxibot
+```
+## Просто эхо-бот
+Необходимо создать файл `echo_bot.py` и добавить в него следующий код.
+Для начала надо проинициализировать бота, делается это следующим образом:
+```python
+from maxibot import MaxiBot
+
+bot = maxibot.Maxibot("TOKEN")
+```
+После этой декларации нам нужно зарегистрировать так называемых обработчиков сообщений. Обработчики сообщений определяют фильтры, которые должно проходить сообщение. Если сообщение проходит через фильтр, вызывается декорированная функция и входящее сообщение передается в качестве аргумента.
+
+Определите определим обработчик сообщений, который обрабатывает входящие `/start` и `/help` команды.
+```python
+@bot.message_handler(commands=['start', 'help'])
+def send_welcome(message):
+	bot.send_message(message, "Привет! Как дела?")
+```
+Добавим ещё один обработчик сообщения, который будет повторять отправленный текст:
+```python
+@bot.message_handler(func=lambda m: True)
+def echo_all(message):
+	bot.send_message(message, message.text)
+```
+Для того, чтобы запустить бота, запустим полинг событий следующей командой:
+```python
+bot.polling()
+```
+Для простого эхо-бота это всё. Наш файл теперь выглядит так:
+```python
+from maxibot import MaxiBot
+
+bot = maxibot.Maxibot("TOKEN")
+
+@bot.message_handler(commands=['start', 'help'])
+def send_welcome(message):
+	bot.send_message(message, "Привет! Как дела?")
+
+@bot.message_handler(func=lambda m: True)
+def echo_all(message):
+	bot.send_message(message, message.text)
+
+bot.polling()
+```
+Чтобы запустить бота, просто откройте терминал и введите `python echo_bot.py`, чтобы запустить бота.  
+Проверьте его, отправив команды (`/start` и `/help`) и произвольные текстовые сообщения.

maxibot-1.0.3/README.md

@@ -0,0 +1,55 @@
+[![PyPi Package Version](https://img.shields.io/pypi/v/maxibot.svg)](https://pypi.python.org/pypi/maxibot)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/maxibot.svg)](https://pypi.python.org/pypi/maxibot)
+[![Documentation Status](https://img.shields.io/badge/docs-passing-green)](https://github.com/mrProduktivnyy/maxibot/tree/main/maxibot/docs)
+[![PyPi downloads](https://img.shields.io/pypi/dm/maxibot.svg)](https://pypi.org/project/maxibot/)
+[![PyPi status](https://img.shields.io/pypi/status/maxibot.svg?style=flat-square)](https://pypi.python.org/pypi/maxibot)
+
+## Быстрый старт
+Необходимо установить библиотеку  
+```sh
+pip install maxibot
+```
+## Просто эхо-бот
+Необходимо создать файл `echo_bot.py` и добавить в него следующий код.
+Для начала надо проинициализировать бота, делается это следующим образом:
+```python
+from maxibot import MaxiBot
+
+bot = maxibot.Maxibot("TOKEN")
+```
+После этой декларации нам нужно зарегистрировать так называемых обработчиков сообщений. Обработчики сообщений определяют фильтры, которые должно проходить сообщение. Если сообщение проходит через фильтр, вызывается декорированная функция и входящее сообщение передается в качестве аргумента.
+
+Определите определим обработчик сообщений, который обрабатывает входящие `/start` и `/help` команды.
+```python
+@bot.message_handler(commands=['start', 'help'])
+def send_welcome(message):
+	bot.send_message(message, "Привет! Как дела?")
+```
+Добавим ещё один обработчик сообщения, который будет повторять отправленный текст:
+```python
+@bot.message_handler(func=lambda m: True)
+def echo_all(message):
+	bot.send_message(message, message.text)
+```
+Для того, чтобы запустить бота, запустим полинг событий следующей командой:
+```python
+bot.polling()
+```
+Для простого эхо-бота это всё. Наш файл теперь выглядит так:
+```python
+from maxibot import MaxiBot
+
+bot = maxibot.Maxibot("TOKEN")
+
+@bot.message_handler(commands=['start', 'help'])
+def send_welcome(message):
+	bot.send_message(message, "Привет! Как дела?")
+
+@bot.message_handler(func=lambda m: True)
+def echo_all(message):
+	bot.send_message(message, message.text)
+
+bot.polling()
+```
+Чтобы запустить бота, просто откройте терминал и введите `python echo_bot.py`, чтобы запустить бота.  
+Проверьте его, отправив команды (`/start` и `/help`) и произвольные текстовые сообщения.