https://github.com/planet-a-ventures/dlt-source-notion
DLT (www.github.com/dlt-hub/dlt) source for Personio (www.notion.com)
https://github.com/planet-a-ventures/dlt-source-notion
data-engineering data-load-tool data-loading dlt dlthub notion python
Last synced: 2 months ago
JSON representation
DLT (www.github.com/dlt-hub/dlt) source for Personio (www.notion.com)
- Host: GitHub
- URL: https://github.com/planet-a-ventures/dlt-source-notion
- Owner: planet-a-ventures
- License: mit
- Created: 2025-03-17T13:34:24.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-17T15:56:05.000Z (2 months ago)
- Last Synced: 2025-03-17T16:35:11.748Z (2 months ago)
- Topics: data-engineering, data-load-tool, data-loading, dlt, dlthub, notion, python
- Language: Python
- Homepage:
- Size: 66.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
description: dlt source for notion.com
keywords: [notion API, notion.com]
---
# dlt-source-notion
[](https://pypi.org/project/dlt-source-notion/)
[DLT](https://dlthub.com/) source for [notion](https://www.notion.com/).
Currently loads the following data:
| Table | Contains |
| -- | -- |
| `persons` | Items of the `user` model of type `person` |
| `bots` | Items of the `user` model of type `bot` |
## Why are you not using the `dlt-hub/verified-sources` notion source / Differences
The [official verified source](https://github.com/dlt-hub/verified-sources/tree/master/sources/notion)
has a few drawbacks:
- on usage of the verified source, a copy of the current state of
the `dlt-hub/verified-sources` repository is copied into your project;
Once you make changes to it, it effectively becomes a fork,
making it hard to update after the fact.
- This makes use of a preexisting client implementation
## Usage
Create a `.dlt/secrets.toml` with your API key and email:
```toml
notion_token = "ntn_abcd12345"
```
and then run the default source with optional list references:
```py
from dlt_source_notion import source as notion_source
pipeline = dlt.pipeline(
pipeline_name="notion_pipeline",
destination="duckdb",
dev_mode=True,
)
notion_data = notion_source()
pipeline.run(notion_data)
```
## Development
This project is using [devenv](https://devenv.sh/).
Commands:
| Command | What does it do? |
| -- | -- |
| `format` | Formats & lints all code |
| `sample-pipeline-run` | Runs the sample pipeline. By default `dev_mode=True` which fetches resources with a limit of 1 (page) |
| `sample-pipeline-show` | Starts the streamlit-based dlt hub |
### Run the sample
```sh
NOTION_TOKEN=[...] \
sample-pipeline-run
```
alternatively you can also create a `.dlt/secrets.toml`
(excluded from git) with the following content:
```toml
notion_token = "ntn_abcd12345"
```