Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sky-alin/telegram-text

📝 Python markup module for Telegram messenger
https://github.com/sky-alin/telegram-text

markdown python telegram

Last synced: 1 day ago
JSON representation

📝 Python markup module for Telegram messenger

Host: GitHub
URL: https://github.com/sky-alin/telegram-text
Owner: SKY-ALIN
License: mit
Created: 2022-05-06T16:28:14.000Z (almost 3 years ago)
Default Branch: dev
Last Pushed: 2024-09-16T05:38:26.000Z (5 months ago)
Last Synced: 2025-02-05T07:47:10.523Z (5 days ago)
Topics: markdown, python, telegram
Language: Python
Homepage: https://telegram-text.alinsky.tech
Size: 1.36 MB
Stars: 89
Watchers: 3
Forks: 5
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # 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](https://img.shields.io/pypi/pyversions/telegram-text.svg)](https://github.com/SKY-ALIN/telegram-text)

![Tests](https://github.com/SKY-ALIN/telegram-text/actions/workflows/tests.yml/badge.svg)

![Code Quality](https://github.com/SKY-ALIN/telegram-text/actions/workflows/code-quality.yml/badge.svg)

[![codecov](https://codecov.io/gh/SKY-ALIN/telegram-text/branch/dev/graph/badge.svg?token=BK0ASC89B9)](https://codecov.io/gh/SKY-ALIN/telegram-text)

[![PyPI version fury.io](https://badge.fury.io/py/telegram-text.svg)](https://pypi.org/project/telegram-text/)

[![license](https://img.shields.io/github/license/SKY-ALIN/telegram-text.svg)](https://github.com/SKY-ALIN/telegram-text/blob/main/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](https://github.com/alexander-akhmetov/python-telegram) | `pip install python-telegram` | `from telegram.text import ...` | [Readme](https://github.com/alexander-akhmetov/python-telegram/blob/master/README.md) |

| [OrigamiBot](https://github.com/cmd410/OrigamiBot) | `pip install origamibot[telegram-text]` | `from origamibot.text import ...` | [Release](https://github.com/cmd410/OrigamiBot/releases/tag/v2.3.0) |

| [TGramBot](https://github.com/KeralaBots/TGramBot) | `pip install tgrambot` | `from tgrambot.text import ...` | [Readme](https://github.com/KeralaBots/TGramBot/blob/alpha/README.md) |

### Basic Example

```python

from telegram_text import Bold, Italic, Underline

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

```



  



### Advanced Example

```python

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](https://raw.githubusercontent.com/SKY-ALIN/telegram-text/dev/docs/source/_static/advanced_example_result.jpg)

---

Full documentation and reference are available at 

[telegram-text.alinsky.tech](https://telegram-text.alinsky.tech)