Skip to main content

Python markup module for Telegram messenger. This module provides a rich list of components to build any possible markup fast and render it to specific html or MarkdownV2 formats.

Project description

telegram-text

Python markup module for Telegram messenger. This module provides a rich list of components to build any possible markup fast and render it to specific html and MarkdownV2 formats.

versions Tests Code Quality codecov PyPI version fury.io license


Installation

Install using pip install telegram-text or poetry add telegram-text

Also, telegram-text is integrated into following packages:

Module Installation Import Documentation
python-telegram pip install python-telegram from telegram.text import ... Readme
OrigamiBot pip install origamibot[telegram-text] from origamibot.text import ... Release
TGramBot pip install tgrambot from tgrambot.text import ... Readme

Basic Example

from telegram_text import Bold, Italic, Underline

text = Underline(Bold("Bold") + "and" + Italic("italic") + "with underline.")

Advanced Example

from telegram_text import Bold, Chain, Italic, TOMLSection, Hashtag, Link, UnorderedList

description = "A Channel about software developing and distributing. Subscribe to follow new technologies."
tags: dict[str, str] = {...}  # Tags description with following format `tag: tag_description`
links: dict[str, str] = {...}  # Links with following format `text: url`

menu = Chain(
    TOMLSection(
        'Menu',
        Italic(description),
    ),
    TOMLSection(
        'Tags',
        *[Hashtag(tag, style=Bold) + f"- {about}" for tag, about in tags.items()],
    ),
    TOMLSection(
        'Links',
        UnorderedList(*[Link(text, url) for text, url in links.items()]),
    ),
    sep='\n\n'
)

Advanced Example Result


Full documentation and reference are available at telegram-text.alinsky.tech

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telegram_text-0.2.0.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

telegram_text-0.2.0-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file telegram_text-0.2.0.tar.gz.

File metadata

  • Download URL: telegram_text-0.2.0.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1018-azure

File hashes

Hashes for telegram_text-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ee295a35f2c77246dd9a80c5e1a8deccc598958dff35740697901c632c6121fa
MD5 afe4ccc01833e755beea2c1c7edad543
BLAKE2b-256 6ecfb707b994ecb759a533e479e57e59ebcf6e806643fff5a53f05743ae817ac

See more details on using hashes here.

File details

Details for the file telegram_text-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: telegram_text-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1018-azure

File hashes

Hashes for telegram_text-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5752744dc5f91f3f7f0ec1becbf10adb86d586d9338e0aef74fd76a7261283ca
MD5 1cdce1d15f7d95629c57d70863b1a629
BLAKE2b-256 2a1e88e9126640be7ddfa423d9ae7ac559577ab8877d45e1d32907c02602cdb3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page