GitHub Gist Python API Docs | dltHub

GitHub Gist is a GitHub service for storing and sharing code snippets and small files (gists) via a REST API. The REST API base URL is https://api.github.com and all requests require a Bearer token (PAT) for authentication when accessing non‑public resources..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading GitHub Gist data in under 10 minutes.

---

What data can I load from GitHub Gist?

Here are some of the endpoints you can load from GitHub Gist:

---

How do I authenticate with the GitHub Gist API?

Uses GitHub Personal Access Tokens (PATs). Include Authorization: Bearer and Accept: application/vnd.github+json. Include X-GitHub-Api-Version: 2022-11-28 optionally.

1. Get your credentials

1. Sign in to GitHub. 2) Go to Settings → Developer settings → Personal access tokens → "Tokens (classic)" or "Fine-grained tokens". 3) Click "Generate new token", select the required scopes (e.g., "gist"), and create the token. 4) Copy the token (it is shown only once).

2. Add them to .dlt/secrets.toml

Copy
[sources.github_gist_source]
token = "ghp_your_personal_access_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the GitHub Gist API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python github_gist_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline github_gist_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset github_gist_data
The duckdb destination used duckdb:/github_gist.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline github_gist_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads gists and gist_comments from the GitHub Gist API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

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

@dlt.source
def github_gist_source(token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.github.com",
            "auth": {
                "type": "bearer",
                "token": token,
            },
        },
        "resources": [
            {"name": "gists", "endpoint": {"path": "gists"}},
            {"name": "gist_comments", "endpoint": {"path": "gists/{gist_id}/comments"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="github_gist_pipeline",
        destination="duckdb",
        dataset_name="github_gist_data",
    )
    load_info = pipeline.run(github_gist_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("github_gist_pipeline").dataset()
sessions_df = data.gists.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM github_gist_data.gists LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("github_gist_pipeline").dataset()
data.gists.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load GitHub Gist data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

If you receive 401 Unauthorized: verify the Authorization header Authorization: Bearer <TOKEN>. Ensure the token includes the gist scope (or other required scopes). Regenerate the token if it has expired or been revoked.

Rate limits

GitHub returns X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers. A 403 Forbidden response with a rate‑limit message indicates the limit has been exceeded; inspect the headers and back off until the reset time.

Pagination

List endpoints return paginated results using the Link response header. Use per_page and page query parameters to control page size. Follow the rel="next" link to retrieve subsequent pages.

Common error codes

• 401 Unauthorized – invalid or missing token.
• 403 Forbidden – rate limit exceeded or insufficient permissions.
• 404 Not Found – resource does not exist (e.g., wrong gist_id).
• 422 Unprocessable Entity – validation errors for write operations.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack