Revert "Refactor python example (dremio-hub#41)" (dremio-hub#49)

This reverts commit 7da259a.

Author: jlarue26

.gitignore

@@ -2,9 +2,3 @@ java/.idea
 java/target
 java/*.iml
 .idea
-*.env
-**/__pycache__
-**/*.egg-info
-**/build
-**/dist
-**/*.pytest_cache

QUICKSTART.md

@@ -12,17 +12,41 @@
 ## 1 Query data using Flight clients
 This process is the same if you launched the Dremio locally or via docker.
 
-### 1.1 Query your datasets with Python
+### 1.1 Query your datasets with arrow flight client in python
+
+This lightweight Python client application connects to the Dremio Arrow Flight server endpoint. It requires the username and password for authentication. Developers can use admin or regular user credentials for authentication. Any datasets in Dremio that are accessible by the provided Dremio user can be queried. By default, the hostname is `localhost` and the port is `32010`. Developers can change these default settings by providing the hostname and port as arguments when running the client. Moreover, the tls option can be provided to establish an encrypted connection.
+
+> Note: Trusted certificates must be provided when the tls option is enabled.
 > 
-#### 1.1.1 Getting Started
+#### 1.1.1 Prerequisites
+
+-   Python 3
 
-1. Install [Python 3](https://www.python.org/downloads/)
-2. Download and install the [dremio-flight-endpoint whl file](https://github.com/dremio-hub/arrow-flight-client-examples/releases)
-    - `python -m pip install <PATH TO WHEEL>` 
-3. Copy the contents of arrow-flight-client-examples/python/example.py into your own python file. 
-4. Run your pthon file with a local instance of Dremio:
-    - `python3 example.py -username <USER> -password <password> -query 'SELECT 1'`
+#### 1.1.2 Instructions on using this Python sample application
 
+-   This application also requires `pyarrow` and `pandas`. Consider one of the dependency installation methods below. We recommend using `conda` for its ease of use.
+	-   Install dependencies using `conda`
+	    -   `conda install -c conda-forge --file requirements.txt`
+	-   Alternatively, install dependencies using `pip`
+	    -   `pip3 install -r requirements.txt`
+-   Run the Python sample application:
+    -   `python3 example.py -host '<DREMIO_HOST>' -user '<DREMIO_USERNAME>' -pass '<DREMIO_PASSWORD>'`
+
+#### 1.1.3 Usage
+```
+example.py [-h] [-host HOSTNAME] [-port FLIGHTPORT] -user USERNAME -pass PASSWORD [-query SQLQUERY] [-tls] [-certs TRUSTEDCERTIFICATES]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -host HOSTNAME, --hostname HOSTNAME Dremio co-ordinator hostname
+  -port FLIGHTPORT, --flightPort FLIGHTPORT Dremio flight server port
+  -user USERNAME, --username USERNAME Dremio username
+  -pass PASSWORD, --password PASSWORD Dremio password
+  -query SQLQUERY, --sqlquery SQLQUERY SQL query to test
+  -tls, --tls Enable encrypted connection
+  -certs TRUSTEDCERTIFICATES, --trustedCertificates TRUSTEDCERTIFICATES Path to trusted certificates for encrypted connection
+```
+---
 
 ### 1.2 Query your dataset with arrow flight client in java
 This lightweight Java client application connects to the Dremio Arrow Flight server endpoint. It requires the username and password for authentication. Developers can use admin or regular user credentials for authentication. Any datasets in Dremio that are accessible by the provided Dremio user can be queried. By default, the hostname is `localhost` and the port is `32010`. Developers can change these default settings by providing the hostname and port as arguments when running the client. Moreover, the tls option can be provided to establish an encrypted connection.

python/README.md

@@ -1,31 +1,23 @@
 # Python Arrow Flight Client Application Example
+![Build Status](https://github.com/dremio-hub/arrow-flight-client-examples/workflows/python-build/badge.svg)
 
-## Getting Started
-1. Install [Python 3](https://www.python.org/downloads/)
-2. Download and install the [dremio-flight-endpoint whl file](https://github.com/dremio-hub/arrow-flight-client-examples/releases)
-    - `python -m pip install <PATH TO WHEEL>` 
-3. Copy the contents of arrow-flight-client-examples/python/example.py into your own python file. 
-4. Run your pthon file with a local instance of Dremio:
-    - `python3 example.py -username <USER> -password <password> -query 'SELECT 1'`
-
-## How to connect to Dremio Cloud
-
-Get started with your first query to Dremio Cloud.
-
-* The following example requires you to create a [Personal Access Token](https://docs.dremio.com/cloud/security/authentication/personal-access-token/) in Dremio. Replace ```<INSERT PAT HERE>``` in the example below with your actual PAT token.
-* You may need to wait for a Dremio engine to start up or start it manually if no Dremio engine for your Organization is running.
-
-This example queries the Dremio Sample dataset ```NYC-taxi-trips``` and returns the first 10 values.
-
-```python3 example.py -host data.dremio.cloud -port 443 -pat '<INSERT PAT HERE>' -tls -query 'SELECT * FROM Samples."samples.dremio.com"."NYC-taxi-trips" limit 10'```
-
-You have now run your first Flight query on Dremio Cloud!
+This lightweight Python client application connects to the Dremio Arrow Flight server endpoint. Developers can use token based or regular user credentials (username/password) for authentication. Please note username/password is not supported for Dremio Cloud. Any datasets in Dremio that are accessible by the provided Dremio user can be queried. By default, the hostname is `localhost` and the port is `32010`. Developers can change these default settings by providing the hostname and port as arguments when running the client.
+Moreover, the tls option can be provided to establish an encrypted connection.
 
-## Configuration Options
+### Instructions on using this Python sample application
+- Install and setup Python3 as `pyarrow` requires Python3
+- This application also requires `pyarrow` and `pandas`. Consider one of the dependency installation methods below. We recommend using `conda` for its ease of use.
+- Install dependencies using `conda`
+  - `conda install -c conda-forge --file requirements.txt`
+- Alternatively, install dependencies using `pip` 
+  - `pip3 install -r requirements.txt`
+- Run the Python sample application with a local instance of Dremio (with default parameters):
+  - `python3 example.py -query 'SELECT 1'`
 
 ```
-usage: example.py [-h] [-host HOSTNAME] [-port PORT] -user USERNAME -pass PASSWORD -pat TOKEN -query QUERY [-tls] [-dcv DISABLE_CERTIFICATE_VERIFICATION]
-                  [-path_to_certs PATH_TO_CERTS] [-sp [SESSION_PROPERTIES ...]] [-engine ENGINE]
+usage: example.py [-h] [-host HOSTNAME] [-port PORT] [-user USERNAME] [-pass PASSWORD]
+                  [-pat, -authToken PAT_OR_AUTH_TOKEN] [-query QUERY] [-tls] [-dsv DISABLE_SERVER_VERIFICATION]
+                  [-certs TRUSTED_CERTIFICATES] [-sessionProperties [SESSION_PROPERTIES ...]] [-engine ENGINE]
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -34,27 +26,57 @@ optional arguments:
   -port PORT, --flightport PORT
                         Dremio flight server port. Defaults to 32010.
   -user USERNAME, --username USERNAME
-                        Dremio username. Not required when connecting to Dremio Cloud
+                        Dremio username. Defaults to "dremio".
   -pass PASSWORD, --password PASSWORD
-                        Dremio password. Not required when connecting to Dremio Cloud
-  -pat TOKEN, --token TOKEN
+                        Dremio password. Defaults to "dremio123".
+  -pat PAT_OR_AUTH_TOKEN, --personalAccessToken PAT_OR_AUTH_TOKEN, -authToken PAT_OR_AUTH_TOKEN, --authToken PAT_OR_AUTH_TOKEN
                         Either a Personal Access Token or an OAuth2 Token.
   -query QUERY, --sqlQuery QUERY
-                        SQL query to test. Must be enclosed in single quotes. If single quotes are already present within the query, change those to double quotes and
-                        enclose entire query in single quotes.
+                        SQL query to test.
   -tls, --tls           Enable encrypted connection. Defaults to False.
-  -dcv DISABLE_CERTIFICATE_VERIFICATION, --disableCertificateVerification DISABLE_CERTIFICATE_VERIFICATION
-                        Disables TLS server verification. Defaults to False.
-  -path_to_certs PATH_TO_CERTS, --trustedCertificates PATH_TO_CERTS
+  -dsv DISABLE_SERVER_VERIFICATION, --disableServerVerification DISABLE_SERVER_VERIFICATION
+                        Disable TLS server verification. Defaults to False.
+  -certs TRUSTED_CERTIFICATES, --trustedCertificates TRUSTED_CERTIFICATES
                         Path to trusted certificates for encrypted connection. Defaults to system certificates.
-  -sp [SESSION_PROPERTIES ...], --sessionProperty [SESSION_PROPERTIES ...]
-                        Key value pairs of SessionProperty, example: -sp schema='Samples."samples.dremio.com"' -sp key=value
+  -sessionProperties [SESSION_PROPERTIES ...], --sessionProperties [SESSION_PROPERTIES ...]
+                        Key value pairs of SessionProperty, example: -sessionProperties schema='Samples."samples.dremio.com"'
   -engine ENGINE, --engine ENGINE
-                        The specific engine to run against. Only applicable to Dremio Cloud.
+                        The specific engine to run against.
+```
 
+### Getting Started
+
+Get started with your first query to Dremio Cloud.
+
+* The following example requires you to create a [Personal Access Token](https://docs.dremio.com/software/security/personal-access-tokens/) in Dremio. Replace ```<INSERT PAT HERE>``` in the example below with your actual PAT token.
+* You may need to wait for a Dremio engine to start up if no Dremio engine for your Organization is running.
+
+This example queries the Dremio Sample dataset ```NYC-taxi-trips``` and returns the first 10 values.
+
+```python3 example.py -host data.dremio.cloud -port 443 -pat '<INSERT PAT HERE>' -tls -query 'SELECT * FROM Samples."samples.dremio.com"."NYC-taxi-trips" limit 10'```
+
+Running the command will return the following.
+
+``` [INFO] Enabling TLS connection
+[INFO] Trusted certificates provided
+[INFO] Authentication skipped until first request
+[INFO] Query:  SELECT * FROM Samples."samples.dremio.com"."NYC-taxi-trips" limit 10
+[INFO] GetSchema was successful
+[INFO] Schema:  <pyarrow._flight.SchemaResult object at 0x7febe2944610>
+[INFO] GetFlightInfo was successful
+[INFO] Ticket:  <Ticket b'\nDSELECT * FROM Samples."samples.dremio.com"."NYC-taxi-trips" limit 10\x12^\n\\\nDSELECT * FROM Samples."samples.dremio.com"."NYC-taxi-trips" limit 10\x10(\x1a\x12\t\x8a\x883#\x12\xd1\xd9\x1d\x11\x00\xb3\xbbC\xdb\xd9J\t'>
+[INFO] Reading query results from Dremio
+      pickup_datetime  passenger_count  trip_distance_mi  fare_amount  tip_amount  total_amount
+0 2013-05-27 19:15:00                1              1.26          7.5        0.00          8.00
+1 2013-05-31 16:40:00                1              0.73          5.0        1.20          7.70
+2 2013-05-27 19:03:00                2              9.23         27.5        5.00         38.33
+3 2013-05-31 16:24:00                1              2.27         12.0        0.00         13.50
+4 2013-05-27 19:17:00                1              0.71          5.0        0.00          5.50
+5 2013-05-27 19:11:00                1              2.52         10.5        3.15         14.15
+6 2013-05-31 16:41:00                5              1.01          6.0        1.10          8.60
+7 2013-05-31 16:37:00                1              1.25          8.5        0.00         10.00
+8 2013-05-31 16:39:00                1              2.04         10.0        1.50         13.00
+9 2013-05-27 19:02:00                1             11.73         32.5        8.12         41.12
 ```
 
-## Description
-![Build Status](https://github.com/dremio-hub/arrow-flight-client-examples/workflows/python-build/badge.svg)
-This lightweight Python client application connects to the Dremio Arrow Flight server endpoint. Developers can use token based or regular user credentials (username/password) for authentication. Please note username/password is not supported for Dremio Cloud. Any datasets in Dremio that are accessible by the provided Dremio user can be queried. By default, the hostname is `localhost` and the port is `32010`. Developers can change these default settings by providing the hostname and port as arguments when running the client.
-Moreover, the tls option can be provided to establish an encrypted connection.
+You have now run your first Flight query on Dremio Cloud!