Final Release of Bot Framework Python SDK

Bot Framework Python SDK has reached end-of-life. This is the last planned release. This project will no longer be updated or maintained. Customers using this SDK will not be disrupted. However, the SDK will no longer be supported through service tickets in the Azure portal and will not receive product updates.

To build agents with your choice of AI services, orchestration, and knowledge, consider using the Microsoft 365 Agents SDK. The Agents SDK is GA and has support for C#, JavaScript or Python. You can learn more about the Agents SDK at aka.ms/agents. If you're looking for a SaaS-based agent platform, consider Microsoft Copilot Studio. If you have an existing bot built with the Bot Framework SDK, you can update your bot to the Agents SDK. You can review the core changes and updates at Bot Framework SDK to Agents SDK migration guidance here. Support tickets for the Bot Framework SDK will no longer be serviced as of December 31, 2025.

What's Changed

• port: Add Teams read receipt event (#6356) by gandiddi in #2167
• Port: Add support for new Teams invoke types 'config/fetch' and 'config/submit' by gandiddi in #2170
• Port: Add settings.selectedChannel to TeamsChannelData and Type to ChannelInfo and TeamDetails by gandiddi in #2173
• Port: Send targeted meeting notification in Teams meeting by gandiddi in #2172
• Port: TeamsChannelData need OnBehalfOf [#6609] by gandiddi in #2175
• port: SkillDialog.InterceptOAuthCardsAsync doesn't support CloudAdapter (#6848) by gandiddi in #2179
• Add missing parameter in exchange_token() call by gandiddi in #2182
• Port: Support Teams message edit, message soft delete, message undelete activities by gandiddi in #2183
• Port: Add new handler for anonymous query link invoke by gandiddi in #2184
• Port: Set TeamsNotifyUser alert to opposite of alert_in_meeting by gandiddi in #2185
• Added missing parameters to the ARM template for Python bot deployment. by gandiddi in #2191
• Bumped pytest by gandiddi in #2189
• Bump: aiohttp from 3.10.5 to 3.10.11 by Dependabot (@dependabot) in #2190
• Port auth error handling from microsoft_app_credentials to certificate_app_credentials by Konstantin Plis (@kostyaplis) in #2196
• bump: MSAL package to 1.31.1 by tracyboehrer (@tracyboehrer) in #2203
• MentionRemoved fix by Axel Suárez (@axelsrz) in #2216
• fix: Method name is emit_event, not emit by Alex Recuenco (@alexrecuenco) in #2215
• Typo on link by Alex Recuenco (@alexrecuenco) in #2217
• Teams SSO and OAuth fixes (#2226) by tracyboehrer (@tracyboehrer) in #2228

New Contributors

• Alex Recuenco (@alexrecuenco) made their first contribution in #2215

Full Changelog: 4.16.2...4.17.0

This release contains a fix for a regression in allowing disabled auth for local testing, and fixes for certificate auth.

What's Changed

• Fix for ConfigurationServiceClientCredentialFactory to allow auth disabled scenario by tracyboehrer (@tracyboehrer) in #2135
• Remove the colon (':') from keywords such as "Parameters", "Remarks" and "Returns" in comments. by gandiddi in #2130
• Added CertificateServiceClientCredentialsFactory by tracyboehrer (@tracyboehrer) in #2132

This July release of the Bot Framework Python SDK contains support for User Assigned MSI.

The document Provision and publish a bot can be used for instructions. Note that this document has not been updated to indicate Python support, but either the C# or JS instructions will work.

Updated ARM templates for Python can be found at: https://github.com/microsoft/BotBuilder-Samples/tree/main/samples/python/02.echo-bot/deploymentTemplates/deployUseExistResourceGroup

This is the June 2024 release of the Python Bot Framework SDK. This release contains security and other parity fixes.

What's Changed

• aiohttp 3.9.5 by tracyboehrer (@tracyboehrer) in #2127
• Parity in CloudAdapterBase.update_activity to use correct activity id by tracyboehrer (@tracyboehrer) in #2120
• fix: Corrections for errors in Skill Dialogs by tracyboehrer (@tracyboehrer) in #2110
• Removed invalid exchange_token check by tracyboehrer (@tracyboehrer) in #2121
• fix populating token issuers by harvey-k in #2117
• bump: aiohttp from 3.9.3 to 3.9.4 in /libraries/botbuilder-adapters-slack by Dependabot (@dependabot) in #2097
• bump: requests dependency by Dependabot (@dependabot) in #2108
• bump: requests from 2.31.0 to 2.32.0 by Dependabot (@dependabot) in #2109
• Added CosmosDB warning: Use CosmosDbPartitionedStorage instead. by tracyboehrer (@tracyboehrer) in #2104
• Updated README with supported Python versions by tracyboehrer (@tracyboehrer) in #2113
• bump: aiohttp from 3.9.3 to 3.9.4 in /libraries/botbuilder-integration-aiohttp by Dependabot (@dependabot) in #2098
• Bump the pip group across 2 directories with 1 update by Dependabot (@dependabot) in #2100
• bump: aiohttp to 3.9.4 in SDK packages by tracyboehrer (@tracyboehrer) in #2115
• Resolved the inconsistency in response formats between the Python Echo bot template and the C# and JavaScript Echo bot templates. by gandiddi in #2124
• Bump azure-storage-queue by tracyboehrer (@tracyboehrer) in #2126

Full Changelog: 4.15.0...4.15.1

This is the April 2024 release of the Python Bot Framework SDK. This release contains Single Tenant support and security fixes.

NOTE
The aiohttp package version 3.9+ now require Python 3.8+. If your bot uses Python 3.7 or earlier, you will need to update to 3.8+. This would include updating the Python version in the App Service if deployed to Azure.

What's Changed

• djangorestframework bump by tracyboehrer (@tracyboehrer) in #2063
• aiohttp to 3.9.3 by tracyboehrer (@tracyboehrer) in #2069
• Bump cryptography from 41.0.6 to 42.0.0 in /libraries/botbuilder-dialogs by Dependabot (@dependabot) in #2068
• Bump cryptography from 41.0.6 to 42.0.0 in /libraries/botframework-connector by Dependabot (@dependabot) in #2067
• Bump cryptography from 41.0.6 to 42.0.0 in /libraries/botbuilder-core by Dependabot (@dependabot) in #2066
• django to 3.2.24 by tracyboehrer (@tracyboehrer) in #2070
• Moved non-library code out of libraries by tracyboehrer (@tracyboehrer) in #2072
• Skipping Slack test if env not setup by tracyboehrer (@tracyboehrer) in #2073
• SingleTenant support by tracyboehrer (@tracyboehrer) in #2055
• bump: cryptography from 42.0.0 to 42.0.4 in /libraries/botbuilder-core by Dependabot (@dependabot) in #2079
• bump: cryptography from 42.0.0 to 42.0.4 in /libraries/botframework-connector by Dependabot (@dependabot) in #2080
• bump: cryptography from 42.0.0 to 42.0.4 in /libraries/botbuilder-dialogs by Dependabot (@dependabot) in #2081
• Fix TeamsChannelAccount model by Nuno André (@nuno-andre) in #2083
• Removed unused tests by tracyboehrer (@tracyboehrer) in #2087
• Corrected Gov LoginUrl prefix by tracyboehrer (@tracyboehrer) in #2091
• add properties to ChannelAccount by Alex Acebo (@aacebo) in #2092
• OAuthScope parity with JS and DotNet by tracyboehrer (@tracyboehrer) in #2093
• Updated generators to use CloudAdapter and latest version by tracyboehrer (@tracyboehrer) in #2094

New Contributors

• Nuno André (@nuno-andre) made their first contribution in #2083

Full Changelog: 4.14.8...4.15.0

This is the January 2024 patch release for Python.

What's Changed

• #2040: fix usage of ResourceResponse to use named argument by Alex Acebo (@aacebo) in #2057
• Python 3.11 Pylint by Alex Acebo (@aacebo) in #2060
• fix: Save a reference to created tasks, to avoid tasks disappearing by ali (@anio) in #2005
• fix: Treat HTTPException as it is, necessary to keep the original status code by Takeshi YASHIRO (@takeshi-yashiro) in #1939
• Avoid exceptions for request without Content-Type header #1881 by Ivo Pisarovic (@ivopisarovic) in #1961
• Ensure Connector Client is retrieved in teams_info.py by Rampaged in #2062

New Contributors

• ali (@anio) made their first contribution in #2005
• Takeshi YASHIRO (@takeshi-yashiro) made their first contribution in #1939
• Ivo Pisarovic (@ivopisarovic) made their first contribution in #1961

Full Changelog: 4.14.7...4.14.8

This is the December 2023 patch release for the Python SDK. It contains dependency updates, security fixes, and other minor fixes.

What's Changed

• Exporting ConfigurationBotFrameworkAuthentication by tracyboehrer (@tracyboehrer) in #2034
• updated teams info for cloud adapter by Axel Suárez (@axelsrz) in #1776
• fix: cloudAdapter.update_conversation() add app_id parameter by Konstantin Plis (@kostyaplis) in #2037
• Bump aiohttp from 3.8.5 to 3.8.6 in /libraries/botbuilder-adapters-slack by Dependabot (@dependabot) in #2039
• Bump aiohttp from 3.8.5 to 3.8.6 in /libraries/botbuilder-integration-aiohttp by Dependabot (@dependabot) in #2038
• chore: Bump aiohttp from 3.8.6 to 3.9.0 in /libraries/botbuilder-integration-aiohttp by Dependabot (@dependabot) in #2041
• chore: Bump aiohttp from 3.8.6 to 3.9.0 in /libraries/botbuilder-adapters-slack by Dependabot (@dependabot) in #2042
• chore: Bump cryptography from 41.0.4 to 41.0.6 in /libraries/botbuilder-dialogs by Dependabot (@dependabot) in #2044
• chore: Bump cryptography from 41.0.4 to 41.0.6 in /libraries/botframework-connector by Dependabot (@dependabot) in #2045
• chore: Bump cryptography from 41.0.4 to 41.0.6 in /libraries/botbuilder-core by Dependabot (@dependabot) in #2046
• msrest to 0.7.* by tracyboehrer (@tracyboehrer) in #2051
• Dialogs: regex version bump by tracyboehrer (@tracyboehrer) in #2050

New Contributors

• Konstantin Plis (@kostyaplis) made their first contribution in #2037

Full Changelog: 4.14.6...4.14.7

This is the 4.14.6 release of the Pyhton SDK. This release corrects some CloudAdapter and Teams issues.

What's Changed

• Exporting ConfigurationBotFrameworkAuthentication
• Updated teams info for cloud adapter

This is the October 2023 release of the Python SDK. This release adds security and Python 3.11 changes.

We are happy to announce the deprecation of the Python SDK has been cancelled. The Python SDK will receive regular updates and support going forward.

What's Changed

• Python 3.11 Compatibility by Alex Acebo (@aacebo) in #2022
• chore: Bump aiohttp from 3.8.4 to 3.8.5 in /libraries/botbuilder-adapters-slack by Dependabot (@dependabot) in #2009
• chore: Bump aiohttp from 3.8.4 to 3.8.5 in /libraries/botbuilder-integration-aiohttp by Dependabot (@dependabot) in #2010
• chore: Bump cryptography from 39.0.1 to 41.0.3 in /libraries/botframework-connector by Dependabot (@dependabot) in #2011
• chore: Bump cryptography from 39.0.1 to 41.0.3 in /libraries/botbuilder-core by Dependabot (@dependabot) in #2012
• chore: Bump cryptography from 39.0.1 to 41.0.3 in /libraries/botbuilder-dialogs by Dependabot (@dependabot) in #2013
• Bump cryptography from 39.0.1 to 41.0.4 in /libraries/botbuilder-core by Dependabot (@dependabot) in #2023
• chore: Cryptograhphy to 41.0.4 by tracyboehrer (@tracyboehrer) in #2026
• chore: django to 3.2.20 by tracyboehrer (@tracyboehrer) in #2027
• chore: flask to 2.2.5 by tracyboehrer (@tracyboehrer) in #2028
• chore: django to 3.2.21 by tracyboehrer (@tracyboehrer) in #2029
• chore: Removed unused slacktestbot by tracyboehrer (@tracyboehrer) in #2030

New Contributors

• Alex Acebo (@aacebo) made their first contribution in #2022

Full Changelog: 4.14.4...4.14.5