Skip to content

Commit f185876

Browse files
committed
Revise README for supported platforms and installation instructions; add licensing details for DLLs
1 parent cc8e837 commit f185876

2 files changed

Lines changed: 39 additions & 34 deletions

File tree

README.md

Lines changed: 39 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,25 @@
44

55
Releases can be found on the [GitHub Releases](https://github.com/microsoft/mssql-python/releases) page.
66

7-
## Platform Compatibility
7+
## Supported Platforms
88

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.
9+
Windows
1010

11-
## Key Features
12-
13-
### DBAPI v2.0 Compliance
14-
15-
The Microsoft **mssql-python** module is designed to be fully compliant with the DB API 2.0 specification. This ensures that the driver adheres to a standardized interface for database access in Python, providing consistency and reliability across different database systems. Key aspects of DBAPI v2.0 compliance include:
16-
17-
- **Connection Objects**: Establishing and managing connections to the database.
18-
- **Cursor Objects**: Executing SQL commands and retrieving results.
19-
- **Transaction Management**: Supporting commit and rollback operations to ensure data integrity.
20-
- **Error Handling**: Providing a consistent set of exceptions for handling database errors.
21-
- **Parameter Substitution**: Allowing the use of placeholders in SQL queries to prevent SQL injection attacks.
22-
23-
By adhering to the DB API 2.0 specification, the mssql-python module ensures compatibility with a wide range of Python applications and frameworks, making it a versatile choice for developers working with Microsoft SQL Server, Azure SQL Database, and Azure SQL Managed Instance.
24-
25-
### Ease of Installation
26-
27-
- **pip install**: The easiest way to install mssql-python is through the Python package manager, pip, irrespective of the Operating System. This ensures a quick and straightforward setup process without the need for additional tools, software, or compilers.
28-
```bash
29-
pip install mssql-python
30-
```
31-
32-
- **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].
33-
- [TODO] - Steps to follow to install the driver using .zip file.
34-
35-
### Support for Microsoft Entra ID Authentication
11+
> **Note:**
12+
> Support for macOS and Linux is coming soon
13+
>
14+
## Installation
3615

37-
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.
38-
39-
### Enhanced Pythonic Features
40-
41-
The driver offers a suite of Pythonic enhancements that streamline database interactions, making it easier for developers to execute queries, manage connections, and handle data more efficiently.
16+
mssql-python can be installed with [pip](http://pypi.python.org/pypi/pip)
17+
```bash
18+
pip install mssql-python
19+
```
4220

43-
### Example Usage
21+
### Getting Started Examples
4422

45-
Below is a simple example demonstrating how to establish a connection and execute a query using mssql-python:
23+
- [ ] Why is it import mssql_python and not mssql-python?
24+
25+
Connect to SQL Server and execute a simple query:
4626

4727
```python
4828
import mssql_python
@@ -66,6 +46,31 @@ for row in rows:
6646
# Close the connection
6747
connection.close()
6848
```
49+
## Documentation
50+
51+
- [ ] Add link to the API documentation in Wiki
52+
53+
## Key Features
54+
55+
### DBAPI v2.0 Compliance
56+
57+
The Microsoft **mssql-python** module is designed to be fully compliant with the DB API 2.0 specification. This ensures that the driver adheres to a standardized interface for database access in Python, providing consistency and reliability across different database systems. Key aspects of DBAPI v2.0 compliance include:
58+
59+
- **Connection Objects**: Establishing and managing connections to the database.
60+
- **Cursor Objects**: Executing SQL commands and retrieving results.
61+
- **Transaction Management**: Supporting commit and rollback operations to ensure data integrity.
62+
- **Error Handling**: Providing a consistent set of exceptions for handling database errors.
63+
- **Parameter Substitution**: Allowing the use of placeholders in SQL queries to prevent SQL injection attacks.
64+
65+
By adhering to the DB API 2.0 specification, the mssql-python module ensures compatibility with a wide range of Python applications and frameworks, making it a versatile choice for developers working with Microsoft SQL Server, Azure SQL Database, and Azure SQL Managed Instance.
66+
67+
### Support for Microsoft Entra ID Authentication
68+
69+
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.
70+
71+
### Enhanced Pythonic Features
72+
73+
The driver offers a suite of Pythonic enhancements that streamline database interactions, making it easier for developers to execute queries, manage connections, and handle data more efficiently.
6974

7075
## Contributing
7176

File renamed without changes.

0 commit comments

Comments
 (0)