Creates google-like navigation menu using python-telegram-bot wrapper
Project description
python telegram bot menu pagination
Description
Makes a google style pagination line for a list of items.
In other words it builds a menu for navigation if you have a lot of search results or whatever list of anything
Installation
pip install ptb-menu-navigation
or if you are working with source code and use Poetry tool:
make install
Usage
from paginator import get_menu
Use get_menu
function to create a line of pages
Example:
from paginator import get_menu
from dataclasses import dataclass
# Define initial menu settings in the dataclass.
@dataclass
class Menu:
items_per_page: int = 10
pages_per_line: int = 3
navigation_signature: str = '±'
page_label: str = ' p. '
# Add the initial call of get_menu
def handling_input(update, context):
# ...
# On first invocation
navigation = get_menu(total_items=len(search_results),
current_page=1,
menu_settings=Menu)
# ...
# Add a callback to handle a page switching
def navigate(update, context):
# ...
navigation = get_menu(total_items=len(search_results),
current_page=int(current_page),
menu_settings=Menu)
# ...
where search_results
is a list of strings and current_page
is a number extracted from a callback_data
.
See examples/search_bot.py
Demo bot launch
Create a .env
file with a TOKEN
variable
inside of an /examples
for launching
the
demo bot.
eg:
TOKEN=<YOUR_TELEGRAM_BOT_TOKEN_FROM_BOT_FATHER>
You may also provide some additional menu values in the same .env
file:
ITEMS_PER_PAGE=1
PAGES_PER_LINE=1
NAVIGATION_SIGNATURE="±"
PAGE_LABEL=" p. "
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ptb-menu-pagination-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | edc53630bc551f86fae10e57cd5a01e8722c501d7e5aca800c685e42d49e8348 |
|
MD5 | 0dc629618a490ab4f8f3d1e007ad2be9 |
|
BLAKE2b-256 | 030881179050896e0197759f98bfb3d01fcefaca11e0fc249eaa69642c61c665 |
Hashes for ptb_menu_pagination-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63b3a6a5104d431c562c161dd2a34278495c570f71ac04093b3a85d0afbc31a5 |
|
MD5 | d8d969a7737238ae180c7df902d3cf9d |
|
BLAKE2b-256 | 5ce6048be925993a9164c0f0f06aaa83e8fe0945a6c9a0550cfc1821f7bf4b72 |