Load Readme data to DuckDB

ReadMe is a platform for creating and managing product and API documentation. Everything needed to build a working Readme → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your Readme to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from Readme to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Readme API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

Readme API at a glance

These values come from the Readme API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the Readme API?

Authentication is performed using an Authorization header with the Bearer scheme, formatted as 'Authorization: Bearer '.

1. Get your credentials

1. Log in to your ReadMe project dashboard.
2. Navigate to 'Configuration' in the sidebar.
3. Select 'API Keys'.
4. Click the blue 'Generate' (or '+') button in the top right corner to create a new key.
5. Provide a label for the key and store it securely, as it will not be displayed again.

2. Add them to .dlt/secrets.toml

Copy
[sources.readme_source]
readme_api_key = "your_api_key_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What Readme data can I load into DuckDB?

These are the Readme endpoints dlt can load into DuckDB:

---

How do I load only new Readme records?

Readme exposes page on guides, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

Copy
{"name": "guides", "endpoint": {
    "path": "guides",
    "data_selector": "data",
    "incremental": {"cursor_path": "page", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated Readme pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /projects/{subdomain}/apikeys and /v2/projects/me from the Readme API into DuckDB:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def readme_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.readme.com/v2",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "guides", "endpoint": {"path": "guides", "data_selector": "data"}},
            {"name": "changelogs", "endpoint": {"path": "changelogs", "data_selector": "data"}}
        ],
    }
    yield from rest_api_resources(config)


def load_readme_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="readme_pipeline",
        destination="duckdb",
        dataset_name="readme_data",
    )
    load_info = pipeline.run(readme_source())
    print(load_info)


if __name__ == "__main__":
    load_readme_to_duckdb()

Run it with python readme_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query Readme data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("readme_pipeline").dataset()
df = data.guides.df()
print(df.head())

SQL:

Copy
SELECT * FROM readme_data.guides LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the Readme to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw Readme loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load Readme data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack