Skip to content

Commit

Permalink
Update to version 5.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Mustafa Asaad committed Mar 8, 2022
1 parent 262f812 commit 8d7684b
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 39 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# CHANGELOG
## _v5.4_
- Added the the parameter creates_join_request to the methods createChatInviteLink and editChatInviteLink for managing chat invite links that create join requests (read more about this on our blog).
- Added the fields creates_join_request and pending_join_request_count to the class ChatInviteLink.
- Added the field name to the class ChatInviteLink and the parameters name to the methods createChatInviteLink and editChatInviteLink for managing invite link names.
- Added updates about new requests to join the chat, represented by the class ChatJoinRequest and the field chat_join_request in the Update class. The bot must be an administrator in the chat with the can_invite_users administrator right to receive these updates.
- Added the methods approveChatJoinRequest and declineChatJoinRequest for managing requests to join the chat.
- Added support for the choose_sticker action in the method sendChatAction.


## _v5.3_
### Personalized Commands
- Bots can now show lists of commands tailored to specific situations - including localized commands for users with different languages, as well as different commands based on chat type or for specific chats, and special lists of commands for chat admins.
Expand Down
27 changes: 8 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Ultimate [Telegram Bot API](https://core.telegram.org/bots/api) Client Framework

[![GPLv2 license](https://img.shields.io/badge/LICENSE-GPLv2-red)](https://github.com/ma24th/tgbotapi/blob/master/LICENSE)
[![PyPI](https://img.shields.io/badge/PyPI-v5.3-yellow.svg)](https://pypi.org/project/tgbotapi/)
[![PyPI](https://img.shields.io/badge/PyPI-v5.4-yellow.svg)](https://pypi.org/project/tgbotapi/)
![Python package](https://github.com/MA24th/tgbotapi/workflows/Python%20package/badge.svg)
![Upload Python Package](https://github.com/MA24th/tgbotapi/workflows/Upload%20Python%20Package/badge.svg)

Expand Down Expand Up @@ -103,24 +103,13 @@ bot.polling()
To start the bot, simply open up a terminal and enter `python echo_bot.py` to run the bot! Test it by sending commands ('/start' and '/help') and arbitrary text messages.

### ChangeLog
**_version 5.3_**
### Personalized Commands
- Bots can now show lists of commands tailored to specific situations - including localized commands for users with different languages, as well as different commands based on chat type or for specific chats, and special lists of commands for chat admins.
- Added the class BotCommandScope, describing the scope to which bot commands apply.
- Added the parameters scope and language_code to the method setMyCommands to allow bots specify different commands for different chats and users.
- Added the parameters scope and language_code to the method getMyCommands.
- Added the method deleteMyCommands to allow deletion of the bot's commands for the given scope and user language.
- Improved visibility of bot commands in Telegram apps with the new 'Menu' button in chats with bots, read more on the blog.

### Custom Placeholders
- Added the ability to specify a custom input field placeholder in the classes ReplyKeyboardMarkup and ForceReply.

### And More
- Improved documentation of the class ChatMember by splitting it into 6 subclasses.
- Renamed the method kickChatMember to banChatMember.
- Renamed the method getChatMembersCount to getChatMemberCount.
- Values of the field file_unique_id in objects of the type PhotoSize and of the fields small_file_unique_id and big_file_unique_id in objects of the type ChatPhoto were changed.

**_version 5.4_**
- Added the the parameter creates_join_request to the methods createChatInviteLink and editChatInviteLink for managing chat invite links that create join requests (read more about this on our blog).
- Added the fields creates_join_request and pending_join_request_count to the class ChatInviteLink.
- Added the field name to the class ChatInviteLink and the parameters name to the methods createChatInviteLink and editChatInviteLink for managing invite link names.
- Added updates about new requests to join the chat, represented by the class ChatJoinRequest and the field chat_join_request in the Update class. The bot must be an administrator in the chat with the can_invite_users administrator right to receive these updates.
- Added the methods approveChatJoinRequest and declineChatJoinRequest for managing requests to join the chat.
- Added support for the choose_sticker action in the method sendChatAction.
**_Fixes_**
- No Issues until Now

Expand Down
1 change: 1 addition & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
| > 5.1 | :white_check_mark: |
| > 5.2 | :white_check_mark: |
| > 5.3 | :white_check_mark: |
| > 5.4 | :white_check_mark: |

## Reporting a Vulnerability

Expand Down
27 changes: 8 additions & 19 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Ultimate [Telegram Bot API](https://core.telegram.org/bots/api) Client Framework

[![GPLv2 license](https://img.shields.io/badge/LICENSE-GPLv2-red)](https://github.com/ma24th/tgbotapi/blob/master/LICENSE)
[![PyPI](https://img.shields.io/badge/PyPI-v5.3-yellow.svg)](https://pypi.org/project/tgbotapi/)
[![PyPI](https://img.shields.io/badge/PyPI-v5.4-yellow.svg)](https://pypi.org/project/tgbotapi/)
![Python package](https://github.com/MA24th/tgbotapi/workflows/Python%20package/badge.svg)
![Upload Python Package](https://github.com/MA24th/tgbotapi/workflows/Upload%20Python%20Package/badge.svg)

Expand Down Expand Up @@ -103,24 +103,13 @@ bot.polling()
To start the bot, simply open up a terminal and enter `python echo_bot.py` to run the bot! Test it by sending commands ('/start' and '/help') and arbitrary text messages.

### ChangeLog
**_version 5.3_**
### Personalized Commands
- Bots can now show lists of commands tailored to specific situations - including localized commands for users with different languages, as well as different commands based on chat type or for specific chats, and special lists of commands for chat admins.
- Added the class BotCommandScope, describing the scope to which bot commands apply.
- Added the parameters scope and language_code to the method setMyCommands to allow bots specify different commands for different chats and users.
- Added the parameters scope and language_code to the method getMyCommands.
- Added the method deleteMyCommands to allow deletion of the bot's commands for the given scope and user language.
- Improved visibility of bot commands in Telegram apps with the new 'Menu' button in chats with bots, read more on the blog.

### Custom Placeholders
- Added the ability to specify a custom input field placeholder in the classes ReplyKeyboardMarkup and ForceReply.

### And More
- Improved documentation of the class ChatMember by splitting it into 6 subclasses.
- Renamed the method kickChatMember to banChatMember.
- Renamed the method getChatMembersCount to getChatMemberCount.
- Values of the field file_unique_id in objects of the type PhotoSize and of the fields small_file_unique_id and big_file_unique_id in objects of the type ChatPhoto were changed.

**_version 5.4_**
- Added the the parameter creates_join_request to the methods createChatInviteLink and editChatInviteLink for managing chat invite links that create join requests (read more about this on our blog).
- Added the fields creates_join_request and pending_join_request_count to the class ChatInviteLink.
- Added the field name to the class ChatInviteLink and the parameters name to the methods createChatInviteLink and editChatInviteLink for managing invite link names.
- Added updates about new requests to join the chat, represented by the class ChatJoinRequest and the field chat_join_request in the Update class. The bot must be an administrator in the chat with the can_invite_users administrator right to receive these updates.
- Added the methods approveChatJoinRequest and declineChatJoinRequest for managing requests to join the chat.
- Added support for the choose_sticker action in the method sendChatAction.
**_Fixes_**
- No Issues until Now

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ def read(filename):


setup(name='tgbotapi',
version='5.3',
version='5.4',
description='The Ultimate Telegram Bot API Client Framework',
long_description=read('README.rst'),
long_description_content_type="text/x-rst",
Expand Down

0 comments on commit 8d7684b

Please sign in to comment.