Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: update the introduction, add the rest_api tutorial #1729

Merged
merged 35 commits into from
Sep 14, 2024
Merged
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
c5d88e6
Add intro, and rest api tutorial
burnash Aug 22, 2024
8fb941d
Update docs/website/docs/tutorial/rest-api.md
burnash Sep 9, 2024
972d31d
Update docs/website/docs/tutorial/rest-api.md
burnash Sep 9, 2024
e7c82ad
Update docs/website/docs/intro.md
burnash Sep 10, 2024
a9d3c83
Fix a broken link
burnash Sep 10, 2024
9c60f9f
Remove the reference to daily updates.
burnash Sep 10, 2024
4e884ad
Update docs/website/docs/tutorial/rest-api.md
burnash Sep 10, 2024
dd488e0
Update docs/website/docs/tutorial/rest-api.md
burnash Sep 10, 2024
ff43a8a
Update docs/website/docs/tutorial/rest-api.md
burnash Sep 11, 2024
b43cfe9
Rework the "merging" section
burnash Sep 11, 2024
d5305b2
Restructure intro, sidebar and dlt tutorial
burnash Sep 12, 2024
2393f9d
Rework why dlt and getting started sections
burnash Sep 12, 2024
990a546
Bring back google colab link
burnash Sep 12, 2024
b25fc09
Merge branch 'devel' into enh/docs/introduction-rest-sql-file
burnash Sep 12, 2024
8f6a7db
Add a missing comma
burnash Sep 12, 2024
3ba59fd
Fix the docs path
burnash Sep 12, 2024
d1cc062
Fix more links
burnash Sep 12, 2024
fb26b98
Update docs/website/docs/intro.md
burnash Sep 12, 2024
838e29b
Fix links
burnash Sep 12, 2024
65dc303
Update docs/website/docs/intro.md
burnash Sep 12, 2024
ed6153f
Update the custom pipeline tutorial
burnash Sep 12, 2024
1601437
Merge branch 'devel' into enh/docs/introduction-rest-sql-file
burnash Sep 13, 2024
71b3e11
Fix a link
burnash Sep 13, 2024
abcc346
Rename sql database page url, add links
burnash Sep 13, 2024
0bf4f76
Incorporate the groupping resources page into the python ds tutorial
burnash Sep 13, 2024
99ca612
Remove legacy tutorial intro and incorporate it to the ds tutorial
burnash Sep 13, 2024
33dd9ca
Elaborate on pds tutorual
burnash Sep 13, 2024
7444c7d
Remove absolute links and hanging whitespace
burnash Sep 13, 2024
c9378ce
Replace the screenshot
burnash Sep 13, 2024
fca18de
Add description and fix text style
burnash Sep 13, 2024
069e4de
Enable module imports in the intro snippets
burnash Sep 13, 2024
b7fa8ca
Format the snippet code
burnash Sep 13, 2024
fc75ccb
Add active version class to document body
burnash Sep 13, 2024
21c6bbc
Revert "Add active version class to document body"
burnash Sep 13, 2024
3c162ab
Add "stable" icons
burnash Sep 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Enable module imports in the intro snippets
burnash committed Sep 13, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 069e4dec8f3970d0dd81f18ad2373bd1ffa50b6a
8 changes: 4 additions & 4 deletions docs/website/docs/intro.md
Original file line number Diff line number Diff line change
@@ -46,9 +46,9 @@ We recommend using a clean virtual environment for your experiments! Here are [d
Use dlt's [REST API source](./tutorial/rest-api) to extract data from any REST API. Define API endpoints you’d like to fetch data from, pagination method and authentication and dlt will handle the rest:

```py
# from dlt.sources import rest_api
from dlt.sources.rest_api import rest_api_source

source = rest_api({
source = rest_api_source({
"client": {
"base_url": "https://api.example.com/",
"auth": {
@@ -81,7 +81,7 @@ Follow the [REST API source tutorial](./tutorial/rest-api) to learn more about t
Use the [SQL source](./tutorial/sql-database) to extract data from the database like PostgreSQL, MySQL, SQLite, Oracle and more.

```py
# from dlt.sources.sql import sql_database
from dlt.sources.sql_database import sql_database

source = sql_database(
"mysql+pymysql://[email protected]:4497/Rfam"
@@ -104,7 +104,7 @@ Follow the [SQL source tutorial](./tutorial/sql-database) to learn more about th
[Filesystem](./tutorial/filesystem) source extracts data from AWS S3, Google Cloud Storage, Google Drive, Azure, or a local file system.

```py
# from dlt.sources.filesystem import filesystem
from dlt.sources.filesystem import filesystem

source = filesystem(
bucket_url="s3://example-bucket",