Add Quick Start section in the Docs

Author: igorborgest

README.md

@@ -16,6 +16,32 @@
 | **PyPi**  | [![PyPI Downloads](https://img.shields.io/pypi/dm/awswrangler.svg)](https://pypi.org/project/awswrangler/)                      | [Link](https://pypi.org/project/awswrangler/)        | `pip install awswrangler`                  |
 | **Conda** | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/awswrangler.svg)](https://anaconda.org/conda-forge/awswrangler) | [Link](https://anaconda.org/conda-forge/awswrangler) | `conda install -c conda-forge awswrangler` |
 
+## Quick Start
+
+Install the Wrangler with: ```pip install awswrangler```
+
+```py3
+import awswrangler as wr
+import pandas as pd
+
+df = pd.DataFrame({"id": [1, 2], "value": ["foo", "boo"]})
+
+# Storing data on Data Lake
+wr.s3.to_parquet(
+    df=df,
+    path="s3://bucket/dataset/",
+    dataset=True,
+    database="my_db",
+    table="my_table"
+)
+
+# Retrieving the data directly from Amazon S3
+df = wr.s3.read_parquet("s3://bucket/dataset/", dataset=True)
+
+# Retrieving the data from Amazon Athena
+df = wr.athena.read_sql_query("SELECT * FROM my_table", database="my_db")
+```
+
 ## [Read The Docs](https://aws-data-wrangler.readthedocs.io/en/dev-1.0.0/index.html)
 
 - [**What is AWS Data Wrangler?**](https://aws-data-wrangler.readthedocs.io/en/dev-1.0.0/what.html)

docs/source/index.rst

@@ -1,13 +1,32 @@
-.. role::  raw-html(raw)
-    :format: html
+Quick Start
+-----------
 
-AWS Data Wrangler
-=================
-*Pandas on AWS*
+    >>> pip install awswrangler
 
-.. image:: _static/logo_transparent.png
-    :width: 40%
-    :alt: AWS Data Wrangler
+.. code-block:: py3
+
+    import awswrangler as wr
+    import pandas as pd
+
+    df = pd.DataFrame({"id": [1, 2], "value": ["foo", "boo"]})
+
+    # Storing data on Data Lake
+    wr.s3.to_parquet(
+        df=df,
+        path="s3://bucket/dataset/",
+        dataset=True,
+        database="my_db",
+        table="my_table"
+    )
+
+    # Retrieving the data directly from Amazon S3
+    df = wr.s3.read_parquet("s3://bucket/dataset/", dataset=True)
+
+    # Retrieving the data from Amazon Athena
+    df = wr.athena.read_sql_query("SELECT * FROM my_table", database="my_db")
+
+Read The Docs
+-------------
 
 .. toctree::
    :maxdepth: 2

docs/source/install.rst

@@ -66,29 +66,25 @@ SageMaker kernels (`Reference <https://github.com/aws-samples/amazon-sagemaker-n
     set -e
 
     # OVERVIEW
-    # This script installs a single pip package in all SageMaker conda environments, apart from the JupyterSystemEnv which is a
-    # system environment reserved for Jupyter.
-    # Note this may timeout if the package installations in all environments take longer than 5 mins, consider using "nohup" to run this
-    # as a background process in that case.
+    # This script installs a single pip package in all SageMaker conda environments, apart from the JupyterSystemEnv which
+    # is a system environment reserved for Jupyter.
+    # Note this may timeout if the package installations in all environments take longer than 5 mins, consider using
+    # "nohup" to run this as a background process in that case.
 
-    sudo -u ec2-user -i <<EOF
+    sudo -u ec2-user -i <<'EOF'
 
     # PARAMETERS
     PACKAGE=awswrangler
 
     # Note that "base" is special environment name, include it there as well.
     for env in base /home/ec2-user/anaconda3/envs/*; do
         source /home/ec2-user/anaconda3/bin/activate $(basename "$env")
-
         if [ $env = 'JupyterSystemEnv' ]; then
-        continue
+            continue
         fi
-
         nohup pip install --upgrade "$PACKAGE" &
-
         source /home/ec2-user/anaconda3/bin/deactivate
     done
-
     EOF
 
 EMR

tutorials/03 - Amazon S3.ipynb

@@ -42,8 +42,7 @@
     "\t* [4.2 Reading multiple FWF files](#4.2-Reading-multiple-FWF-files)\n",
     "\t\t* [4.2.1 Reading FWF by list](#4.2.1-Reading-FWF-by-list)\n",
     "\t\t* [4.2.2 Reading FWF by prefix](#4.2.2-Reading-FWF-by-prefix)\n",
-    "* [5. List objects](#5.-List-objects)\n",
-    "* [6. Delete objects](#6.-Delete-objects)\n"
+    "* [5. Delete objects](#6.-Delete-objects)\n"
    ]
   },
   {
@@ -1143,41 +1142,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 5. List objects"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 19,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "['s3://aws-data-wrangler-test-bucket-98ohux1n29m8/csv/file1.csv',\n",
-       " 's3://aws-data-wrangler-test-bucket-98ohux1n29m8/csv/file2.csv',\n",
-       " 's3://aws-data-wrangler-test-bucket-98ohux1n29m8/fwf/file1.txt',\n",
-       " 's3://aws-data-wrangler-test-bucket-98ohux1n29m8/fwf/file2.txt',\n",
-       " 's3://aws-data-wrangler-test-bucket-98ohux1n29m8/json/file1.json',\n",
-       " 's3://aws-data-wrangler-test-bucket-98ohux1n29m8/json/file2.json',\n",
-       " 's3://aws-data-wrangler-test-bucket-98ohux1n29m8/parquet/file1.parquet',\n",
-       " 's3://aws-data-wrangler-test-bucket-98ohux1n29m8/parquet/file2.parquet']"
-      ]
-     },
-     "execution_count": 19,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "wr.s3.list_objects(f\"s3://{bucket}/\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 6. Delete objects"
+    "# 5. Delete objects"
    ]
   },
   {
@@ -1207,17 +1172,8 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.6.5"
-  },
-  "pycharm": {
-   "stem_cell": {
-    "cell_type": "raw",
-    "metadata": {
-     "collapsed": false
-    },
-    "source": []
-   }
   }
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}