Skip to content

Commit 95621a0

Browse files
committed
Revise README for clarity and conciseness; enhance platform compatibility section
1 parent dd7181e commit 95621a0

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# Microsoft Python Data Provider for SQL Server and Azure SQL
1+
# Microsoft Python Data Provider for SQL Server
22

3-
The Microsoft **mssql-python** data provider is a powerful, user-friendly Python connector designed for seamless interaction with Microsoft SQL Server, Azure SQL Database, and Azure SQL Managed Instance databases using Direct Database Connectivity (DDBC). DDBC allows Python applications to connect directly to SQL Server, bypassing the need for an external driver manager. This driver is crafted to adhere to the [DB API 2.0](https://peps.python.org/pep-0249/) specification while incorporating additional Pythonic features that enhance its ease of use and functionality. The driver offers comprehensive functionalities, including establishing connections, executing queries, and managing transactions among many other features.
3+
**mssql-python** is a Python data provider for Microsoft SQL Server and the Azure SQL family of databases. It leverages Direct Database Connectivity (DDBC) that enables direct connections to SQL Server without requiring an external driver manager. Designed to comply with the [DB API 2.0](https://peps.python.org/pep-0249/) specification, this driver also introduces Pythonic enhancements for improved usability and functionality. It supports a full range of database operations, including connection management, query execution, and transaction handling.
4+
5+
Releases can be found on the [GitHub Releases](https://github.com/microsoft/mssql-python/releases) page.
6+
7+
## Platform Compatibility
8+
9+
The current release of mssql-python is tailored for the Windows platform. Future updates will extend compatibility to Mac and Linux, ensuring a consistent installation experience and feature set across all platforms. Stay tuned for more updates in this space.
410

511
## Key Features
612

@@ -26,10 +32,6 @@ By adhering to the DB API 2.0 specification, the mssql-python module ensures com
2632
- **Offline install using zip file**: Another way of installing the driver is using a .zip file which can be downloaded from here [TODO: Link of the zip file].
2733
- [TODO] - Steps to follow to install the driver using .zip file.
2834

29-
### Platform Compatibility
30-
31-
The current release of mssql-python is tailored for the Windows platform. Future updates will extend compatibility to Mac and Linux, ensuring a consistent installation experience and feature set across all platforms. Stay tuned for more updates in this space.
32-
3335
### Support for Microsoft Entra ID Authentication
3436

3537
The Microsoft mssql-python driver enables Python applications to connect to Microsoft SQL Server, Azure SQL Database, or Azure SQL Managed Instance using Microsoft Entra ID identities. It supports various authentication methods, including username and password, Microsoft Entra managed identity, and Integrated Windows Authentication in a federated, domain-joined environment. Additionally, the driver supports Microsoft Entra interactive authentication and Microsoft Entra managed identity authentication for both system-assigned and user-assigned managed identities.

0 commit comments

Comments
 (0)