Skip to content

Commit 6539d71

Browse files
author
Warren Chu
committed
added standard Microsoft Github docs to root folder, and updated README and LICENSE docs
1 parent 4aacfd4 commit 6539d71

File tree

5 files changed

+108
-47
lines changed

5 files changed

+108
-47
lines changed

CODE_OF_CONDUCT

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Microsoft Open Source Code of Conduct
2+
3+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
4+
5+
Resources:
6+
7+
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
8+
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
9+
- Contact [[email protected]](mailto:[email protected]) with questions or concerns

LICENSE

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,9 @@
1-
BSD 3-Clause License
1+
MIT License
22

3-
Copyright (c) 2019, ES Solutions AB
4-
All rights reserved.
3+
Copyright (c) Microsoft Corporation.
54

6-
Redistribution and use in source and binary forms, with or without
7-
modification, are permitted provided that the following conditions are met:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
86

9-
* Redistributions of source code must retain the above copyright notice, this
10-
list of conditions and the following disclaimer.
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
118

12-
* Redistributions in binary form must reproduce the above copyright notice,
13-
this list of conditions and the following disclaimer in the documentation
14-
and/or other materials provided with the distribution.
15-
16-
* Neither the name of the copyright holder nor the names of its
17-
contributors may be used to endorse or promote products derived from
18-
this software without specific prior written permission.
19-
20-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

README.rst

Lines changed: 40 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
django-mssql-backend
2-
====================
1+
# Project
32

43
.. image:: https://img.shields.io/pypi/v/django-mssql-backend.svg
54
:target: https://pypi.python.org/pypi/django-mssql-backend
65

6+
Welcome to the MSSQL-Django 3rd party backend project!
7+
78
*django-mssql-backend* is a fork of
8-
`django-pyodbc-azure <https://pypi.org/project/django-pyodbc-azure/>`__
9+
`django-pyodbc-azure <https://pypi.org/project/django-pyodbc-azure/>`
10+
11+
This project provides an enterprise database connectivity option for the Django Web Framework, with support for Microsoft SQL Server and Azure SQL Database.
12+
13+
We hope you enjoy using the MSSQL-Django 3rd party backend.
914

10-
Features
11-
--------
15+
## Features
1216

1317
- Supports Django 2.2, 3.0
1418
- Supports Microsoft SQL Server 2008/2008R2, 2012, 2014, 2016, 2017, 2019
@@ -18,14 +22,12 @@ Features
1822
`SQL Server Native Client <https://msdn.microsoft.com/en-us/library/ms131321(v=sql.120).aspx>`__,
1923
and `FreeTDS <http://www.freetds.org/>`__ ODBC drivers
2024

21-
Dependencies
22-
------------
25+
## Dependencies
2326

2427
- Django 2.2 or newer
2528
- pyodbc 3.0 or newer
2629

27-
Installation
28-
------------
30+
## Installation
2931

3032
1. Install pyodbc and Django
3133

@@ -39,18 +41,15 @@ Installation
3941

4042
'ENGINE': 'sql_server.pyodbc'
4143

42-
Regex Support
43-
-------------
44+
## Regex Support
4445

4546
django-mssql-backend supports regex using a CLR .dll file. To install it, run ::
4647

4748
python manage.py install_regex_clr {database_name}
4849

49-
Configuration
50-
-------------
50+
## Configuration
5151

52-
Standard Django settings
53-
~~~~~~~~~~~~~~~~~~~~~~~~
52+
### Standard Django settings
5453

5554
The following entries in a database-level settings dictionary
5655
in DATABASES control the behavior of the backend:
@@ -112,8 +111,7 @@ for any given database-level settings dictionary:
112111
mirror during testing. Default value is ``None``.
113112
See the official Django documentation for more details.
114113

115-
OPTIONS
116-
~~~~~~~
114+
### OPTIONS
117115

118116
Dictionary. Current available keys are:
119117

@@ -193,7 +191,7 @@ Dictionary. Current available keys are:
193191
Integer. Sets the timeout in seconds for the database query.
194192
Default value is ``0`` which disables the timeout.
195193

196-
backend-specific settings
194+
### Backend-specific settings
197195
~~~~~~~~~~~~~~~~~~~~~~~~~
198196

199197
The following project-level settings also control the behavior of the backend:
@@ -203,8 +201,7 @@ The following project-level settings also control the behavior of the backend:
203201
Boolean. If it is set to ``False``, pyodbc's connection pooling feature
204202
won't be activated.
205203

206-
Example
207-
~~~~~~~
204+
### Example
208205

209206
Here is an example of the database settings:
210207

@@ -228,9 +225,30 @@ Here is an example of the database settings:
228225
# set this to False if you want to turn off pyodbc's connection pooling
229226
DATABASE_CONNECTION_POOLING = False
230227

231-
Limitations
232-
-----------
228+
## Limitations
233229

234230
The following features are currently not supported:
235231

236232
- Altering a model field from or to AutoField at migration
233+
234+
## Contributing
235+
236+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
237+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
238+
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
239+
240+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
241+
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
242+
provided by the bot. You will only need to do this once across all repos using our CLA.
243+
244+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
245+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
246+
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
247+
248+
## Trademarks
249+
250+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
251+
trademarks or logos is subject to and must follow
252+
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
253+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
254+
Any use of third-party trademarks or logos are subject to those third-party's policies.

SECURITY.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
2+
3+
## Security
4+
5+
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
6+
7+
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
8+
9+
## Reporting Security Issues
10+
11+
**Please do not report security vulnerabilities through public GitHub issues.**
12+
13+
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
14+
15+
If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
16+
17+
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
18+
19+
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
20+
21+
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
22+
* Full paths of source file(s) related to the manifestation of the issue
23+
* The location of the affected source code (tag/branch/commit or direct URL)
24+
* Any special configuration required to reproduce the issue
25+
* Step-by-step instructions to reproduce the issue
26+
* Proof-of-concept or exploit code (if possible)
27+
* Impact of the issue, including how an attacker might exploit the issue
28+
29+
This information will help us triage your report more quickly.
30+
31+
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
32+
33+
## Preferred Languages
34+
35+
We prefer all communications to be in English.
36+
37+
## Policy
38+
39+
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
40+
41+
<!-- END MICROSOFT SECURITY.MD BLOCK -->

SUPPORT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Support
2+
3+
## How to file issues and get help
4+
5+
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
6+
issues before filing new issues to avoid duplicates. For new issues, file your bug or
7+
feature request as a new Issue.
8+
9+
For help and questions about using this project, please utilize the Django Developers form at https://groups.google.com/g/django-developers. Please search for an existing discussion on your topic before adding a new conversation. For new conversations, include "MSSQL" in a descriptive subject.
10+
11+
## Microsoft Support Policy
12+
13+
Support for this project is limited to the resources listed above.

0 commit comments

Comments
 (0)