Skip to content

Commit 201ba54

Browse files
committed
Add "what is?" section int the docs
1 parent 08b2265 commit 201ba54

File tree

4 files changed

+13
-5
lines changed

4 files changed

+13
-5
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# AWS Data Wrangler
2-
3-
![AWS Data Wrangler](docs/source/_static/logo2.png?raw=true "AWS Data Wrangler")
4-
52
> Pandas on AWS
3+
![AWS Data Wrangler](docs/source/_static/logo2.png?raw=true "AWS Data Wrangler")
64

75
[![Release](https://img.shields.io/badge/release-1.0.0-brightgreen.svg)](https://pypi.org/project/awswrangler/)
86
[![Python Version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-brightgreen.svg)](https://anaconda.org/conda-forge/awswrangler)
@@ -20,6 +18,7 @@
2018

2119
## [Read The Docs](https://aws-data-wrangler.readthedocs.io/en/dev-1.0.0/index.html)
2220

21+
- [**What is AWS Data Wrangler?**](https://aws-data-wrangler.readthedocs.io/en/dev-1.0.0/what.html)
2322
- [**Install**](https://aws-data-wrangler.readthedocs.io/en/dev-1.0.0/install.html)
2423
- [PyPi (pip)](https://aws-data-wrangler.readthedocs.io/en/dev-1.0.0/install.html#pypi-pip)
2524
- [Conda](https://aws-data-wrangler.readthedocs.io/en/dev-1.0.0/install.html#conda)

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@
8181
# Note the "1" or "True" value above as the third argument to indicate
8282
# an arbitrary url.
8383
"navbar_links": [
84+
("What is Data Wrangler?", "what"),
8485
("Install", "install"),
8586
("Tutorials", "https://github.com/awslabs/aws-data-wrangler/tree/dev-1.0.0/tutorials", True),
8687
("API Reference", "api"),

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33

44
AWS Data Wrangler
55
=================
6+
*Pandas on AWS*
67

78
.. image:: _static/logo_transparent.png
89
:width: 40%
910
:alt: AWS Data Wrangler
1011

11-
*Pandas on AWS*
12-
1312
.. toctree::
1413
:maxdepth: 2
1514

15+
what
1616
install
1717
Tutorials <https://github.com/awslabs/aws-data-wrangler/tree/dev-1.0.0/tutorials>
1818
api

docs/source/what.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
What is AWS Data Wrangler?
2+
==========================
3+
4+
An `open-source <https://github.com/awslabs/aws-data-wrangler>`_ Python package that extends the power of `Pandas <https://github.com/pandas-dev/pandas>`_ library to AWS connecting **DataFrames** and AWS data related services (**Amazon Redshift**, **AWS Glue**, **Amazon Athena**, **Amazon EMR**, etc).
5+
6+
Built on top of other open-source projects like `Pandas <https://github.com/pandas-dev/pandas>`_, `Apache Arrow <https://github.com/apache/arrow>`_, `Boto3 <https://github.com/boto/boto3>`_, `s3fs <https://github.com/dask/s3fs>`_, `SQLAlchemy <https://github.com/sqlalchemy/sqlalchemy>`_, `Psycopg2 <https://github.com/psycopg/psycopg2>`_ and `PyMySQL <https://github.com/PyMySQL/PyMySQL>`_, it offers abstracted functions to execute usual ETL tasks like load/unload data from **Data Lakes**, **Data Warehouses** and **Databases**.
7+
8+
Do you want to see it in action? Check our `tutorials <https://github.com/awslabs/aws-data-wrangler/tree/dev-1.0.0/tutorials>`_ or the `list of functionalities <https://aws-data-wrangler.readthedocs.io/en/dev-1.0.0/api.html>`_.

0 commit comments

Comments
 (0)