Skip to content

Commit 8857132

Browse files
Update readme and setup.py to fix markdown
1 parent f61cef9 commit 8857132

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
Welcome to the MSSQL-Django 3rd party backend project!
44

5-
*mssql-django* is a fork of
6-
`django-mssql-backend <https://pypi.org/project/django-mssql-backend/>`
5+
*mssql-django* is a fork of [django-mssql-backend](https://pypi.org/project/django-mssql-backend/)
76

87
This project provides an enterprise database connectivity option for the Django Web Framework, with support for Microsoft SQL Server and Azure SQL Database.
98

@@ -15,9 +14,9 @@ We hope you enjoy using the MSSQL-Django 3rd party backend.
1514
- Supports Microsoft SQL Server 2008/2008R2, 2012, 2014, 2016, 2017, 2019
1615
- Passes most of the tests of the Django test suite
1716
- Compatible with
18-
`Micosoft ODBC Driver for SQL Server <https://docs.microsoft.com/en-us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server>`__,
19-
`SQL Server Native Client <https://msdn.microsoft.com/en-us/library/ms131321(v=sql.120).aspx>`__,
20-
and `FreeTDS <http://www.freetds.org/>`__ ODBC drivers
17+
[Micosoft ODBC Driver for SQL Server](https://docs.microsoft.com/en-us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server),
18+
[SQL Server Native Client](https://msdn.microsoft.com/en-us/library/ms131321(v=sql.120).aspx),
19+
and [FreeTDS](http://www.freetds.org/) ODBC drivers
2120

2221
## Dependencies
2322

@@ -32,7 +31,7 @@ We hope you enjoy using the MSSQL-Django 3rd party backend.
3231

3332
pip install mssql-django
3433

35-
3. Set the ``ENGINE`` setting in the settings.py file used by
34+
3. Set the ``ENGINE`` setting in the `settings.py` file used by
3635
your Django application or project to ``'mssql'``
3736

3837
``'ENGINE': 'mssql'``
@@ -107,14 +106,13 @@ Dictionary. Current available keys are:
107106

108107
- driver
109108

110-
String. ODBC Driver to use (``"ODBC Driver 13 for SQL Server"``,
109+
String. ODBC Driver to use (``"ODBC Driver 17 for SQL Server"``,
111110
``"SQL Server Native Client 11.0"``, ``"FreeTDS"`` etc).
112-
Default is ``"ODBC Driver 13 for SQL Server"``.
111+
Default is ``"ODBC Driver 17 for SQL Server"``.
113112

114113
- isolation_level
115114

116-
String. Sets `transaction isolation level
117-
<https://docs.microsoft.com/en-us/sql/t-sql/statements/set-transaction-isolation-level-transact-sql>`__
115+
String. Sets [transaction isolation level](https://docs.microsoft.com/en-us/sql/t-sql/statements/set-transaction-isolation-level-transact-sql)
118116
for each database session. Valid values for this entry are
119117
``READ UNCOMMITTED``, ``READ COMMITTED``, ``REPEATABLE READ``,
120118
``SNAPSHOT``, and ``SERIALIZABLE``. Default is ``None`` which means
@@ -205,7 +203,7 @@ Here is an example of the database settings:
205203
'PORT': '',
206204
207205
'OPTIONS': {
208-
'driver': 'ODBC Driver 13 for SQL Server',
206+
'driver': 'ODBC Driver 17 for SQL Server',
209207
},
210208
},
211209
}
@@ -244,8 +242,8 @@ For security reporting instructions please refer to the SECURITY.md file in this
244242

245243
## Trademarks
246244

247-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
248-
trademarks or logos is subject to and must follow
245+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
246+
trademarks or logos is subject to and must follow
249247
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
250248
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
251249
Any use of third-party trademarks or logos are subject to those third-party's policies.

setup.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Copyright (c) Microsoft Corporation.
22
# Licensed under the MIT license.
33

4+
from os import path
45
from setuptools import find_packages, setup
56

67
CLASSIFIERS = [
@@ -17,11 +18,16 @@
1718
'Framework :: Django :: 3.0',
1819
]
1920

21+
this_directory = path.abspath(path.dirname(__file__))
22+
with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
23+
long_description = f.read()
24+
2025
setup(
2126
name='mssql-django',
22-
version='1.0.a1',
27+
version='1.0a1',
2328
description='Django backend for Microsoft SQL Server',
24-
long_description=open('README.md').read(),
29+
long_description=long_description,
30+
long_description_content_type='text/markdown',
2531
author='Microsoft',
2632
author_email='[email protected]',
2733
url='https://github.com/microsoft/mssql-django',
@@ -30,7 +36,6 @@
3036
install_requires=[
3137
'pyodbc>=3.0',
3238
],
33-
package_data={'mssql': ['regex_clr.dll']},
3439
classifiers=CLASSIFIERS,
3540
keywords='django',
3641
)

0 commit comments

Comments
 (0)