Skip to content

Commit

Permalink
docs(connector): rewrite introduction and form doc structure
Browse files Browse the repository at this point in the history
  • Loading branch information
peiwangdb authored and dovahcrow committed Mar 20, 2021
1 parent e0a4713 commit 6a87693
Showing 1 changed file with 80 additions and 0 deletions.
80 changes: 80 additions & 0 deletions docs/source/user_guide/connector/introduction.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
{
"cells": [
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. _`userguide/connector`:\n",
"\n",
"Connector\n",
"=========\n",
"\n",
"DataPrep.Connector aims to simplify data collection from Web APIs by providing a standard set of operations. \n",
"Connector wraps-up complex API calls into a set of easy-to-use Python functions. \n",
"By using Connector, you can skip the complex API configuration process and rapidly query different Web APIs in few steps, enabling you to execute the analysis workflow you are familiar with in a direct way."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Connector offers essential features to facilitate the process of collecting data, for example:\n",
"\n",
"* Concurrency: Collect data from websites, in parallel, in a fast way!\n",
"\n",
"* Pagination: Retrieve more rows of a particular query without getting into unnecessary detail about pagination schemes!\n",
"\n",
"* Authorization: Access more Web APIs quickly! even the ones that implement authorization!\n",
"\n",
"This section includes a case study for yelp as an example for the process and other sections to explain Connector's functionalities in detail."
]
},
{
"cell_type": "markdown",
"metadata": {
"nbsphinx-toctree": {
"maxdepth": 2,
"titlesonly": true
},
"tags": [
"nbsphinx-toctree"
]
},
"source": [
"## Section Contents\n",
"\n",
" * [Case study: DBLP API](DBLP.ipynb)\n",
" * [Configuration files: usage and composition](config_file.ipynb)\n",
" * [connect(): establish the connection and load the configuration files](connect.ipynb)\n",
" * [query(): fetch into DataFrames via APIs](query.ipynb)\n",
" * [info(): get information of a website](info.ipynb)\n",
" * [Authorization schemes supported](authorization.ipynb)\n",
" * [Auto-pagination](pagination.ipynb)"
]
}
],
"metadata": {
"celltoolbar": "Edit Metadata",
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.7"
}
},
"nbformat": 4,
"nbformat_minor": 4
}

0 comments on commit 6a87693

Please sign in to comment.