Updates to Ruby and Python readme

ajlam · ajlam · commit cc9cdb088477 · 2016-10-27T14:13:31.000-07:00
diff --git a/samples/connect/python/pymssql/linux/README.md b/samples/connect/python/pymssql/linux/README.md
@@ -1,26 +1,74 @@
-# Connect to SQL Database by using Python on Ubuntu Linux
+# Connect to SQL using Python on Ubuntu Linux
 
-[Python code sample] (sample_python_linux.py) that runs on an Ubuntu Linux client computer, to connect to an Azure SQL Database database.
+Python sample code that runs on an Ubuntu Linux client computer to connect to an Azure SQL Database using the **pymssql** connector. 
 
+### Contents
 
-## Requirements
+[About this sample](#about-this-sample)<br/>
+[Before you begin](#before-you-begin)<br/>
+[Run this sample](#run-this-sample)<br/>
+[Sample details](#sample-details)<br/>
+[Disclaimers](#disclaimers)<br/>
+[Related links](#related-links)<br/>
 
 
-- [Python 2.7.6](https://www.python.org/download/releases/2.7.6/).
+<a name=about-this-sample></a>
 
+## About this sample
 
-### Install the required modules
+- **Applies to:** SQL Server 2016 (or higher), Azure SQL Database, Azure SQL Data Warehouse, Parallel Data Warehouse
+- **Workload:** CRUD
+- **Programming Language:** Python
+- **Authors:** Meet Bhagdev [meet-bhagdev]
 
+<a name=before-you-begin></a>
 
-Open your terminal and navigate to a directory where you plan on creating your python script. Enter the following commands to install **FreeTDS** and **pymssql**. pymssql uses FreeTDS to connect to SQL Databases.
+## Before you begin
 
+To run this sample, you need the following prerequisites.
+
+**Software prerequisites:**
+
+1. SQL Server 2016 (or higher) or an Azure SQL Database
+2. Python
+
+	```
 	sudo apt-get --assume-yes update
-	sudo apt-get --assume-yes install freetds-dev freetds-bin
 	sudo apt-get --assume-yes install python-dev python-pip
+	```
+3. FreeTDS 
+     
+	```
+	sudo apt-get --assume-yes install freetds-dev freetds-bin
+	```
+
+4. pymssql 
+
+	```
 	sudo pip install pymssql
+	```
+    
+**Azure prerequisites:**
+
+1. An AdventureWorks sample database: 
+
+	- The Python sample relies on the AdventureWorks sample database. If you do not already have AdventureWorks, you can see how to create it at the following topic: [Create your first Azure SQL Database](http://azure.microsoft.com/documentation/articles/sql-database-get-started/)
+	
+## Run this sample
+
+1. From your terminal, update the connection string details in the Python file with your own username, password, and hostname. 
+
+2. Run the code sample by running the below in your terminal: 
+
+	```
+	python sample_python_linux.py
+	```
 
+<a name=sample-details></a>
 
-## Create a database and retrieve your connection string
+## Sample details
 
+The above sample code just connected to your AdventureWorks database and performed a SELECT statement and an INSERT statement. 
 
-See the [getting started page](http://azure.microsoft.com/documentation/articles/sql-database-get-started/) to learn how to create a sample database and get your connection string. It is important you follow the guide to create an AdventureWorks database template. The samples shown below only work with the AdventureWorks schema. 
+## Disclaimers
+The scripts and this guide are copyright Microsoft Corporations and are provided as samples. They are not part of any Azure service and are not covered by any SLA or other Azure-related agreements. They are provided as-is with no warranties express or implied. Microsoft takes no responsibility for the use of the scripts or the accuracy of this document. Familiarize yourself with the scripts before using them.
diff --git a/samples/connect/python/pymssql/mac/README.md b/samples/connect/python/pymssql/mac/README.md
@@ -1,34 +1,71 @@
-# Connect to SQL Database by using Python on Mac OS
+# Connect to SQL using Python on macOS
 
+Python sample code that runs on an macOS client computer to connect to an Azure SQL Database using the **pymssql** connector.  
 
-[Python code sample] (sample_python_mac.py) that runs on a Mac computer. The sample and connects to Azure SQL Database by using the **pymssql** driver.
+### Contents
 
+[About this sample](#about-this-sample)<br/>
+[Before you begin](#before-you-begin)<br/>
+[Run this sample](#run-this-sample)<br/>
+[Sample details](#sample-details)<br/>
+[Disclaimers](#disclaimers)<br/>
+[Related links](#related-links)<br/>
 
-## Requirements
 
+<a name=about-this-sample></a>
 
-- [Python 2.7.6](https://www.python.org/download/releases/2.7.6/).
-- [FreeTDS](https://github.com/brianb/FreeTDS)
-- [Pymssql](https://github.com/pymssql/pymssql)
+## About this sample
+- **Applies to:** SQL Server 2016 (or higher), Azure SQL Database, Azure SQL Data Warehouse, Parallel Data Warehouse
+- **Workload:** CRUD
+- **Programming Language:** Python
+- **Authors:** Meet Bhagdev [meet-bhagdev]
 
-### Install the required modules
+<a name=before-you-begin></a>
 
+## Before you begin
 
-Open your terminal and install
+To run this sample, you need the following prerequisites.
 
-**1) Homebrew**: Run the following command from your terminal. This will download the Homebrew package manager on your machine.
+**Software prerequisites:**
+1. Homebrew
+	
+	```
+	ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+	```
 
-    ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-
-**2) FreeTDS**: Run the following command from your terminal. This will download FreeTDS on your machine. FreeTDS is required for pymmsql to work.
+2. FreeTDS
 
+	```
     brew install FreeTDS
-  
-**3) Pymmsql**: Run the following command from your terminal. This will install pymmsql on your machine.
+	```
+
+3. tiny_tds
 
+	```
     sudo -H pip install pymssql
+	```
+
+**Azure prerequisites:**
+
+1. An AdventureWorks sample database: 
+
+	- The Python sample relies on the AdventureWorks sample database. If you do not already have AdventureWorks, you can see how to create it at the following topic: [Create your first Azure SQL Database](http://azure.microsoft.com/documentation/articles/sql-database-get-started/)
+	
+## Run this sample
+
+1. From your terminal, update the connection string details in the Python file with your own username, password, and hostname. 
+
+2. Run the code sample by running the below in your terminal: 
+
+	```
+	python sample_python_mac.py
+	```
+
+<a name=sample-details></a>
 
-## Create a database and retrieve your connection string
+## Sample details
 
+The above sample code just connected to your AdventureWorks database and performed a SELECT statement and an INSERT statement. 
 
-See the [getting started page](http://azure.microsoft.com/documentation/articles/sql-database-get-started/) to learn how to create a sample database and get your connection string. It is important you follow the guide to create an **AdventureWorks database template**. The samples shown below only work with the **AdventureWorks schema**. 
+## Disclaimers
+The scripts and this guide are copyright Microsoft Corporations and are provided as samples. They are not part of any Azure service and are not covered by any SLA or other Azure-related agreements. They are provided as-is with no warranties express or implied. Microsoft takes no responsibility for the use of the scripts or the accuracy of this document. Familiarize yourself with the scripts before using them.
diff --git a/samples/connect/python/pyodbc/linux/README.md b/samples/connect/python/pyodbc/linux/README.md
@@ -1,25 +1,75 @@
-# Connect to SQL Database by using Python on Ubuntu Linux using pyodbc
+# Connect to SQL using Python on Ubuntu Linux
 
-[Python code sample] (sample_python_linux.py) that runs on an Ubuntu Linux client computer. The sample and connects to Microsoft SQL Database by using the **pyodbc** driver.
+Python sample code that runs on an Ubuntu Linux client computer to connect to an Azure SQL Database using the **pyodbc** connector. 
 
+### Contents
 
-## Requirements
+[About this sample](#about-this-sample)<br/>
+[Before you begin](#before-you-begin)<br/>
+[Run this sample](#run-this-sample)<br/>
+[Sample details](#sample-details)<br/>
+[Disclaimers](#disclaimers)<br/>
+[Related links](#related-links)<br/>
 
 
-- [Python 2.7.6](https://www.python.org/download/releases/2.7.6/).
+<a name=about-this-sample></a>
 
+## About this sample
 
-### Install the required modules
+- **Applies to:** SQL Server 2016 (or higher), Azure SQL Database, Azure SQL Data Warehouse, Parallel Data Warehouse
+- **Workload:** CRUD
+- **Programming Language:** Python
+- **Authors:** Meet Bhagdev [meet-bhagdev]
 
+<a name=before-you-begin></a>
 
-Open your terminal and navigate to a directory where you plan on creating your python script. Enter the following commands to install **Microsoft ODBC Driver for SQL Server** and **pyodbc**. pyodbc uses the ODBC Driver to connect to SQL Databases.
+## Before you begin
 
-	  sudo su
-	  wget https://gallery.technet.microsoft.com/ODBC-Driver-13-for-Ubuntu-b87369f0/file/154097/2/installodbc.sh
-	  sh installodbc.sh
-	  sudo -H pip install pyodbc
+To run this sample, you need the following prerequisites.
 
+1. SQL Server 2016 (or higher) or an Azure SQL Database
+2. Python
 
-## Create a database and retrieve your connection string
+	```
+	sudo apt-get --assume-yes update
+	sudo apt-get --assume-yes install python-dev python-pip
+	```
 
-For simplicity we will create an Azure SQL Database for the sample. You can use the same sample for an on-premise SQL Server instance. See the [getting started page](http://azure.microsoft.com/documentation/articles/sql-database-get-started/) to learn how to create a sample database and get your connection string. It is important you follow the guide to create an AdventureWorks database template. The samples shown below only work with the AdventureWorks schema. 
+3. Microsoft ODBC Driver for SQL Server
+
+	```
+	sudo su
+	wget https://gallery.technet.microsoft.com/ODBC-Driver-13-for-Ubuntu-b87369f0/file/154097/2/installodbc.sh 
+	sh installodbc.sh
+	```
+
+4. pyodc
+
+	```
+	sudo -H pip install pyodbc
+	```
+
+**Azure prerequisites:**
+
+1. An AdventureWorks sample database: 
+
+	- The Python sample relies on the AdventureWorks sample database. If you do not already have AdventureWorks, you can see how to create it at the following topic: [Create your first Azure SQL Database](http://azure.microsoft.com/documentation/articles/sql-database-get-started/)
+	
+## Run this sample
+
+1. From your terminal, update the connection string details in the Python file with your own username, password, and hostname. 
+
+2. Run the code sample by running the below in your terminal: 
+
+	```
+	python sample_python_linux.py
+	```
+
+<a name=sample-details></a>
+
+## Sample details
+
+The above sample code just connected to your AdventureWorks database and performed a SELECT statement and an INSERT statement. 
+
+## Disclaimers
+The scripts and this guide are copyright Microsoft Corporations and are provided as samples. They are not part of any Azure service and are not covered by any SLA or other Azure-related agreements. They are provided as-is with no warranties express or implied. Microsoft takes no responsibility for the use of the scripts or the accuracy of this document. Familiarize yourself with the scripts before using them.
diff --git a/samples/connect/python/pyodbc/windows/README.md b/samples/connect/python/pyodbc/windows/README.md
@@ -1,29 +1,71 @@
-# Connect to SQL Database by using Python on Windows using pyodbc
+# Connect to SQL using Python on Windows
 
+Python sample code that runs on an Windowsclient computer to connect to an Azure SQL Database using the **pyodbc** connector. 
 
-[Python code sample] (sample_python_windows.py) that runs on a Windows computer. The sample and connects to Microsoft SQL Database by using the **pyodbc** driver.
+### Contents
 
+[About this sample](#about-this-sample)<br/>
+[Before you begin](#before-you-begin)<br/>
+[Run this sample](#run-this-sample)<br/>
+[Sample details](#sample-details)<br/>
+[Disclaimers](#disclaimers)<br/>
+[Related links](#related-links)<br/>
 
-## Requirements
 
+<a name=about-this-sample></a>
 
-- [Python 2.7.6](https://www.python.org/download/releases/2.7.6/).
-- [ODBC Driver 11 or 13 for SQL Server Windows](https://www.microsoft.com/en-us/download/details.aspx?id=50420)
-- [Pyodbc](https://pypi.python.org/pypi/pyodbc/3.0.10)
+## About this sample
 
-### Install the required modules
+- **Applies to:** SQL Server 2016 (or higher), Azure SQL Database, Azure SQL Data Warehouse, Parallel Data Warehouse
+- **Workload:** CRUD
+- **Programming Language:** Python
+- **Authors:** Meet Bhagdev [meet-bhagdev]
 
-Navigate to your Python directory where the pip installer is located. For example C:\Python27\Scripts>. 
+<a name=before-you-begin></a>
 
-####Install pyodbc
+## Before you begin
 
+To run this sample, you need the following prerequisites.
+
+**Software prerequisites:**
+1. SQL Server 2016 (or higher) or an Azure SQL Database
+
+2. Python
+    - [Download from here](https://www.python.org/download/releases/2.7.6/)
+
+3. Microsoft ODBC Driver 11 or 13 for SQL Server Windows
+    - [Download from here](https://www.microsoft.com/en-us/download/details.aspx?id=50420)
+
+4. [Pyodbc](https://pypi.python.org/pypi/pyodbc/3.0.10)
+
+    ```
     pip install pyodbc
+    ```
+
+    *Note: Instructions to enable the use pip can be found [here](http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows)*
+
+
+**Azure prerequisites:**
+
+1. An AdventureWorks sample database: 
+
+	- The Python sample relies on the AdventureWorks sample database. If you do not already have AdventureWorks, you can see how to create it at the following topic: [Create your first Azure SQL Database](http://azure.microsoft.com/documentation/articles/sql-database-get-started/)
+	
+## Run this sample
+
+1. From your terminal, update the connection string details in the Python file with your own username, password, and hostname. 
+
+2. Run the code sample by running the below in your terminal: 
 
-*Note: Instructions to enable the use pip can be found [here](http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows)*
+	```
+	python sample_python_windows.py
+	```
 
+<a name=sample-details></a>
 
-## Create a database and retrieve your connection string
+## Sample details
 
-For simplicity we will create an Azure SQL Database for the sample. You can use the same sample for an on-premise SQL Server instance. See the [getting started page](http://azure.microsoft.com/documentation/articles/sql-database-get-started/) to learn how to create a sample database and get your connection string. It is important you follow the guide to create an AdventureWorks database template. The samples shown below only work with the AdventureWorks schema. 
+The above sample code just connected to your AdventureWorks database and performed a SELECT statement and an INSERT statement. 
 
-See the [getting started page](http://azure.microsoft.com/documentation/articles/sql-database-get-started/) to learn how to create a sample database and get your connection string. It is important you follow the guide to create an **AdventureWorks database template**. The samples shown below only work with the **AdventureWorks schema**. 
+## Disclaimers
+The scripts and this guide are copyright Microsoft Corporations and are provided as samples. They are not part of any Azure service and are not covered by any SLA or other Azure-related agreements. They are provided as-is with no warranties express or implied. Microsoft takes no responsibility for the use of the scripts or the accuracy of this document. Familiarize yourself with the scripts before using them.
diff --git a/samples/connect/ruby/linux/README.md b/samples/connect/ruby/linux/README.md
@@ -1,4 +1,4 @@
-# Sample name
+# Connect to SQL using Ruby on Ubuntu Linux
 
 Ruby sample code that runs on an Ubuntu Linux client computer to connect to an Azure SQL Database. 
 
@@ -26,7 +26,6 @@ To run this sample, you need the following prerequisites.
 
 **Software prerequisites:**
 
-<!-- Examples -->
 1. SQL Server 2016 (or higher) or an Azure SQL Database
 2. Ruby Version Manager
 
diff --git a/samples/connect/ruby/mac/README.md b/samples/connect/ruby/mac/README.md
@@ -1,4 +1,4 @@
- Sample name
+# Connect to SQL using Ruby on macOS
 
 Ruby sample code that runs on a macOS computer to connect to an Azure SQL Database. 
 
diff --git a/samples/connect/ruby/windows/README.md b/samples/connect/ruby/windows/README.md
@@ -1,4 +1,4 @@
-# Sample name
+# Connect to SQL using Ruby on Windows
 
 Ruby sample code that runs on a Windows computer to connect to an Azure SQL Database. 
 
@@ -26,8 +26,6 @@ To run this sample, you need the following prerequisites.
 
 **Software prerequisites:**
 
-<!-- Examples -->
-
 1. Ruby 
 	- [Go the Ruby download page](http://rubyinstaller.org/downloads/) and download the appropriate 2.1.x installer. For example if you are on a 64 bit machine, download the **Ruby 2.1.6 (x64)** installer.
 	- Once the installer is downloaded, do the following:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`- Sample name`
	`1`	`+# Connect to SQL using Ruby on macOS`
`2`	`2`
`3`	`3`	`Ruby sample code that runs on a macOS computer to connect to an Azure SQL Database.`
`4`	`4`