https://github.com/b3b/znamotobot

ZnamoToBot: Telegram bot to show excerpts from awesome lists
https://github.com/b3b/znamotobot

Last synced: 16 days ago
JSON representation

ZnamoToBot: Telegram bot to show excerpts from awesome lists

• Host: GitHub
• URL: https://github.com/b3b/znamotobot
• Owner: b3b
• License: mit
• Created: 2022-07-06T22:21:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-14T20:55:07.000Z (over 2 years ago)
• Last Synced: 2024-05-23T05:32:14.096Z (6 months ago)
• Language: Python
• Homepage:
• Size: 4.6 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
ZnamoToBot

==========

.. start-badges

.. image:: https://img.shields.io/badge/stability-alpha-f4d03f.svg

    :target: https://github.com/b3b/znamotobot

    :alt: Stability

.. image:: https://img.shields.io/docker/v/herethere/znamotobot?color=%23FFD43B&label=Docker%20Image

   :target: https://hub.docker.com/r/herethere/znamotobot

   :alt: Docker Image Version (latest by date)

.. image:: https://github.com/b3b/znamotobot/workflows/tests/badge.svg?branch=main

     :target: https://github.com/b3b/znamotobot/actions?workflow=tests

     :alt: CI Status

.. image:: https://codecov.io/github/b3b/znamotobot/coverage.svg?branch=main

    :target: https://codecov.io/github/b3b/znamotobot?branch=main

    :alt: Code coverage Status

.. end-badges

Inline Telegram bot to show excerpts from `awesome lists `_,

to remind chat users about some topic that has been previously discussed 256x times.

The idea is that list of links to *Your Chat* important messages are stored in collaborative repository.

And chat users can easily insert sections from this list by calling `@YourAwesomeBotName`.

Usage

-----

Simply type the `@YourAwesomeBotName` in the message field in any chat,

then (optinally) type some text to filter sections.

The bot will offer you sections that you can send in one tap.

Bot must have `Inline mode `_ enabled via @BotFather.

Usage demonstration

-------------------

.. image:: docs/usage.gif

  :alt: Bot usage demonstration

List example

------------

Lists are in Markdown format:

.. code-block::

    # Telegram news selection

    ## Stickers

    * [Stickers from video files](https://t.me/telegram/165)

    * [Premium stickers](https://t.me/telegram/181)

    * [@Stickers](https://t.me/telegram/10) — Bot which helps you create sticker packs from your pictures

    ## Usability features

    * [Chat folders](https://t.me/telegram/127) — Helps if you have *too many* chats

    * [Attachment menu](https://t.me/telegram/171)

      When selecting multiple media items, tap  ‘⋯ selected’

      to **preview the message** and **reorder media** before sending

    * [Inline bots](https://t.me/telegram/26)

Run bot with Docker

-------------------

Example command to start the Docker container::

    docker run \

           --rm \

           -e TELEGRAM_TOKEN='token from @BotFather' \

           -e INDEX_URL='https://raw.githubusercontent.com/b3b/znamotobot/main/tests/basic.md' \

           herethere/znamotobot

Setting **INDEX_URL** specifies the list location: local file to load, or URL to remote file to periodically download.

List of all available settings: `znamotobot/settings.py `_

Docker Compose configuration example: `docker-compose.yml `_

Development

-----------

Commands to run locally::

  pip install -r requirements/dev.txt

  make format

  make test

  python -m znamotobot.bot