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

Move sources and destinations to the top level #1750

Merged
merged 8 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 0 additions & 18 deletions docs/website/docs/dlt-ecosystem/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Filesystem
description: dlt verified source for Readers Source and Filesystem
description: AWS S3, Google Cloud Storage, Azure Blob Storage, local files
keywords: [readers source and filesystem, filesystem, readers source]
---
import Header from './_source-info-header.md';
Expand Down Expand Up @@ -123,7 +123,7 @@ For more information, read the

3. You can pass the bucket URL and glob pattern or use `config.toml`. For local filesystems, use
`file://` as follows:

```toml
[sources.filesystem] # use [sources.readers.credentials] for the "readers" source
bucket_url='file://Users/admin/Documents/csv_files'
Expand All @@ -136,7 +136,7 @@ For more information, read the
bucket_url='~\Documents\csv_files\'
file_glob="*"
```

In the example above we use Windows path to current user's Documents folder. Mind that literal toml string (single quotes)
was used to conveniently use the backslashes without need to escape.

Expand Down
48 changes: 31 additions & 17 deletions docs/website/docs/dlt-ecosystem/verified-sources/index.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,48 @@
---
title: Verified sources
description: List of verified sources
keywords: ['verified source']
title: Sources
description: Available sources
keywords: ['source']
---
import DocCardList from '@theme/DocCardList';
import Link from '../../_book-onboarding-call.md';
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

Choose from our collection of verified sources, developed and maintained by the dlt team and community. Each source is rigorously tested against a real API and provided as Python code for easy customization.

Planning to use dlt in production and need a source that isn't listed? We're happy to help you build it: <Link />.
Planning to use `dlt` in production and need a source that isn't listed? We're happy to help you build it: <Link/>.

### Popular sources
### Core sources

- [SQL databases](sql_database). Supports PostgreSQL, MySQL, MS SQL Server, BigQuery, Redshift, and more.
- [REST API generic source](rest_api). Loads data from REST APIs using declarative configuration.
- [OpenAPI source generator](openapi-generator). Generates a source from an OpenAPI 3.x spec using the REST API source.
- [Cloud and local storage](filesystem). Retrieves data from AWS S3, Google Cloud Storage, Azure Blob Storage, local files, and more.
<DocCardList items={useCurrentSidebarCategory().items.filter(
item => item.label === '30+ SQL Databases' || item.label === 'REST API generic source' || item.label === 'Filesystem'
)} />

### Full list of verified sources
### Verified sources

<DocCardList />
Choose from our collection of verified sources, developed and maintained by the `dlt` team and community. Each source is rigorously tested against a real API and provided as Python code for easy customization.

:::tip
If you're looking for a source that isn't listed and it provides a REST API, be sure to check out our [REST API generic source](rest_api)
source.
If you couldn't find a source implementation, you can easily create your own, check out the [resource page](../../general-usage/resource) to learn how!
:::

<DocCardList items={useCurrentSidebarCategory().items.filter(
item => item.label !== '30+ SQL Databases' && item.label !== 'REST API generic source'&& item.label !== 'Filesystem'
)} />

### What's the difference between core and verified sources?

The main difference between the [core sources](#core-sources) and [verified sources](#verified-sources) lies in their structure.
Core sources are generic collections, meaning they can connect to a variety of systems. For example, the [SQL Database source](sql_database) can connect to any
database which supports SQLAlchemy.

According to our telemetry, core sources are the most widely used among our users!

It's also important to note that core sources are integrated into the `dlt` core library,
whereas verified sources are maintained in a separate [repository](https://github.com/dlt-hub/verified-sources).
To use a verified source, you need to run the `dlt` init command, which will download the verified source code to
your working directory.


### Get help

* Source missing? [Request a new verified source.](https://github.com/dlt-hub/verified-sources/issues/new?template=source-request.md)
* Missing endpoint or a feature? [Request or contribute](https://github.com/dlt-hub/verified-sources/issues/new?template=extend-a-source.md)
* [Join our Slack community](https://dlthub.com/community) and ask in the technical-help channel.
* [Join our Slack community](https://dlthub.com/community) and ask in the technical-help channel.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: REST API generic source
description: dlt verified source for REST APIs
description: Loads data from REST APIs using declarative configuration
keywords: [rest api, restful api]
---
import Header from './_source-info-header.md';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 30+ SQL Databases
description: dlt pipeline for SQL Database
description: PostgreSQL, MySQL, MS SQL Server, BigQuery, Redshift, and more
keywords: [sql connector, sql database pipeline, sql database]
---
import Header from './_source-info-header.md';
Expand Down
138 changes: 64 additions & 74 deletions docs/website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,84 +44,74 @@ const sidebars = {
},
{
type: 'category',
label: 'Integrations',
label: 'Sources',
link: {
type: 'doc',
id: 'dlt-ecosystem/index',
id: 'dlt-ecosystem/verified-sources/index',
},
items: [
{
type: 'category',
label: 'Sources',
link: {
type: 'doc',
id: 'dlt-ecosystem/verified-sources/index',
},
items: [
'dlt-ecosystem/verified-sources/airtable',
'dlt-ecosystem/verified-sources/amazon_kinesis',
'dlt-ecosystem/verified-sources/arrow-pandas',
'dlt-ecosystem/verified-sources/asana',
'dlt-ecosystem/verified-sources/chess',
'dlt-ecosystem/verified-sources/facebook_ads',
'dlt-ecosystem/verified-sources/filesystem',
'dlt-ecosystem/verified-sources/freshdesk',
'dlt-ecosystem/verified-sources/github',
'dlt-ecosystem/verified-sources/google_ads',
'dlt-ecosystem/verified-sources/google_analytics',
'dlt-ecosystem/verified-sources/google_sheets',
'dlt-ecosystem/verified-sources/hubspot',
'dlt-ecosystem/verified-sources/inbox',
'dlt-ecosystem/verified-sources/jira',
'dlt-ecosystem/verified-sources/kafka',
'dlt-ecosystem/verified-sources/matomo',
'dlt-ecosystem/verified-sources/mongodb',
'dlt-ecosystem/verified-sources/mux',
'dlt-ecosystem/verified-sources/notion',
'dlt-ecosystem/verified-sources/personio',
'dlt-ecosystem/verified-sources/pg_replication',
'dlt-ecosystem/verified-sources/pipedrive',
'dlt-ecosystem/verified-sources/rest_api',
'dlt-ecosystem/verified-sources/openapi-generator',
'dlt-ecosystem/verified-sources/salesforce',
'dlt-ecosystem/verified-sources/scrapy',
'dlt-ecosystem/verified-sources/shopify',
'dlt-ecosystem/verified-sources/sql_database',
'dlt-ecosystem/verified-sources/slack',
'dlt-ecosystem/verified-sources/strapi',
'dlt-ecosystem/verified-sources/stripe',
'dlt-ecosystem/verified-sources/workable',
'dlt-ecosystem/verified-sources/zendesk'
]
},
{
type: 'category',
label: 'Destinations',
link: {
type: 'doc',
id: 'dlt-ecosystem/destinations/index',
},
items: [
'dlt-ecosystem/destinations/bigquery',
'dlt-ecosystem/destinations/databricks',
'dlt-ecosystem/destinations/duckdb',
'dlt-ecosystem/destinations/mssql',
'dlt-ecosystem/destinations/synapse',
'dlt-ecosystem/destinations/clickhouse',
'dlt-ecosystem/destinations/filesystem',
'dlt-ecosystem/destinations/postgres',
'dlt-ecosystem/destinations/redshift',
'dlt-ecosystem/destinations/snowflake',
'dlt-ecosystem/destinations/athena',
'dlt-ecosystem/destinations/weaviate',
'dlt-ecosystem/destinations/lancedb',
'dlt-ecosystem/destinations/qdrant',
'dlt-ecosystem/destinations/dremio',
'dlt-ecosystem/destinations/destination',
'dlt-ecosystem/destinations/motherduck'
]
},
],
'dlt-ecosystem/verified-sources/airtable',
'dlt-ecosystem/verified-sources/amazon_kinesis',
'dlt-ecosystem/verified-sources/arrow-pandas',
'dlt-ecosystem/verified-sources/asana',
'dlt-ecosystem/verified-sources/chess',
'dlt-ecosystem/verified-sources/facebook_ads',
'dlt-ecosystem/verified-sources/filesystem',
'dlt-ecosystem/verified-sources/freshdesk',
'dlt-ecosystem/verified-sources/github',
'dlt-ecosystem/verified-sources/google_ads',
'dlt-ecosystem/verified-sources/google_analytics',
'dlt-ecosystem/verified-sources/google_sheets',
'dlt-ecosystem/verified-sources/hubspot',
'dlt-ecosystem/verified-sources/inbox',
'dlt-ecosystem/verified-sources/jira',
'dlt-ecosystem/verified-sources/kafka',
'dlt-ecosystem/verified-sources/matomo',
'dlt-ecosystem/verified-sources/mongodb',
'dlt-ecosystem/verified-sources/mux',
'dlt-ecosystem/verified-sources/notion',
'dlt-ecosystem/verified-sources/personio',
'dlt-ecosystem/verified-sources/pg_replication',
'dlt-ecosystem/verified-sources/pipedrive',
'dlt-ecosystem/verified-sources/rest_api',
'dlt-ecosystem/verified-sources/openapi-generator',
'dlt-ecosystem/verified-sources/salesforce',
'dlt-ecosystem/verified-sources/scrapy',
'dlt-ecosystem/verified-sources/shopify',
'dlt-ecosystem/verified-sources/sql_database',
'dlt-ecosystem/verified-sources/slack',
'dlt-ecosystem/verified-sources/strapi',
'dlt-ecosystem/verified-sources/stripe',
'dlt-ecosystem/verified-sources/workable',
'dlt-ecosystem/verified-sources/zendesk'
]
},
{
type: 'category',
label: 'Destinations',
link: {
type: 'doc',
id: 'dlt-ecosystem/destinations/index',
},
items: [
'dlt-ecosystem/destinations/bigquery',
'dlt-ecosystem/destinations/databricks',
'dlt-ecosystem/destinations/duckdb',
'dlt-ecosystem/destinations/mssql',
'dlt-ecosystem/destinations/synapse',
'dlt-ecosystem/destinations/clickhouse',
'dlt-ecosystem/destinations/filesystem',
'dlt-ecosystem/destinations/postgres',
'dlt-ecosystem/destinations/redshift',
'dlt-ecosystem/destinations/snowflake',
'dlt-ecosystem/destinations/athena',
'dlt-ecosystem/destinations/weaviate',
'dlt-ecosystem/destinations/lancedb',
'dlt-ecosystem/destinations/qdrant',
'dlt-ecosystem/destinations/dremio',
'dlt-ecosystem/destinations/destination',
'dlt-ecosystem/destinations/motherduck'
]
},
{
type: 'category',
Expand Down
Loading
Loading