A YAML-configured data fetching library for agentic applications.
Project description
fetchkit
A YAML-configured data-fetching library for agentic applications.
fetchkit collects posts and comments from sources (Hacker News, RSS/Atom, arXiv,
GitHub, Lobsters) into a single canonical Post model, with de-duplication,
deterministic sorting, and a shared HTTP client with retries and rate limiting. It is
designed as the data-collection layer for LLM/agent pipelines — feed it configs, get
back clean typed data.
- YAML-first configuration with strict validation: unknown or misspelled keys are rejected up front, so a bad config fails loudly instead of silently.
- Builtin fetchers: Hacker News, RSS/Atom, arXiv, GitHub, and Lobsters — all zero-auth.
- Relative time windows: say
window: "last 6 hours"instead of computing timestamps. - Open
metadata: eachPostcarries ametadatadict for source-specific detail (arXiv categories/DOI, GitHub language/stars, tags) without bloating the core model. - Robust HTTP: shared session pooling, exponential backoff + retries,
Retry-Afterhandling, and optional per-host rate limiting. - Typed end-to-end: Pydantic v2 models throughout.
- Deterministic output: dedup by
(source, id), sorted descending by(created_at, id). - Agent-friendly CLI:
fetchkit run config.yamlemits clean JSON on stdout — no Python required.
Install
pip install fetchkit-agents # PyPI distribution name
# or install the latest from source:
pip install "git+https://github.com/metemorris/fetchkit.git"
The PyPI package is fetchkit-agents (the fetchkit name was taken), but you still
import fetchkit and the CLI command is fetchkit. Requires Python ≥ 3.10.
Quick start
1. YAML config
config.yaml:
window: "last 24 hours" # or set explicit start_time / end_time
fetchers:
- type: hackernews
posts:
max_items: 50
order: new
- type: arxiv
categories: ["cs.AI", "cs.LG"]
max_items: 40
- type: github
resource: releases
repos: ["python/cpython", "pydantic/pydantic"]
- type: lobsters
listing: hottest
- type: rss
feeds:
- url: "https://feeds.bbci.co.uk/news/rss.xml"
name: "BBC News"
max_items_per_feed: 40
max_total_items: 200
http: # optional
timeout: 15
max_retries: 5
rate_limit_per_host: 2.0
2. Run
from fetchkit import load_config, collect_all
config = load_config("config.yaml")
result = collect_all(config)
print(f"Collected {len(result.posts)} posts")
for post in result.posts:
print(post.created_at, post.source, post.title, post.url)
if result.has_errors:
for source, err in result.errors:
print(f" {source}: {err}")
3. Command line (for agents & scripts)
fetchkit installs a CLI so an agent can shell out and parse JSON without writing
Python. run prints only JSON to stdout (diagnostics go to stderr), so it pipes
cleanly into jq:
fetchkit run config.yaml # pretty JSON: {"count", "posts", "errors"}
fetchkit run config.yaml -o out.json # write JSON to a file (stdout stays empty)
fetchkit run config.yaml --window "6h" # override the time window at runtime
fetchkit run config.yaml --compact # single-line JSON
fetchkit run config.yaml --fail-on-error # exit 1 if any source failed
fetchkit validate config.yaml # validate a config without fetching
python -m fetchkit run config.yaml # module form, identical behavior
Output shape:
{
"count": 2,
"posts": [ { "id": "...", "source": "rss", "title": "...", "url": "...", "created_at": "..." } ],
"errors": [ { "source": "hackernews", "error": "..." } ]
}
Exit codes: 0 success · 1 a source failed (only with --fail-on-error) ·
2 configuration error.
4. Programmatic (no YAML)
from datetime import datetime, timezone, timedelta
from fetchkit import FetchKitConfig, HackerNewsFetchConfig, PostFetchConfig, SortOrder, collect_all
config = FetchKitConfig(
start_time=datetime.now(timezone.utc) - timedelta(days=1),
end_time=datetime.now(timezone.utc),
fetchers=[
HackerNewsFetchConfig(posts=PostFetchConfig(max_items=30, order=SortOrder.NEW)),
],
)
result = collect_all(config)
Configuration reference
Top-level (FetchKitConfig)
| Field | Type | Required | Description |
|---|---|---|---|
window |
str | no | Relative window (resolves to start/end). |
start_time |
datetime | no | Global window start (inclusive). |
end_time |
datetime | no | Global window end (inclusive). |
fetchers |
list[FetcherConfig] | no | Fetcher instances to run. |
http |
HttpConfig | no | Shared HTTP client settings. |
Set the time window with either a relative window or both
start_time/end_time — the two are mutually exclusive. If you specify none of
them, the window defaults to the last 24 hours. start_time <= end_time is
enforced, and unknown top-level keys are rejected. Per-fetcher
start_time/end_time default to None and inherit the global window at runtime.
Relative windows
window accepts (case-insensitive): "last 6 hours", "past 30 minutes",
"last 7 days", "last week", "last month", "today", "yesterday", or a bare
duration like "6h", "2d", "90m". It resolves once to a concrete
(start_time, end_time) pair (end = now), so collection stays deterministic for that
resolved pair. The same parsing is available programmatically via
fetchkit.resolve_window(spec) and fetchkit.parse_duration(text).
Hacker News (type: hackernews)
| Field | Default | Notes |
|---|---|---|
posts.max_items |
10 | 1–500 |
posts.order |
top | top / new / controversial / asc / desc |
comments.fetch |
false | Fetch comment threads for each post |
comments.max_items |
10 | 1–100 roots per post |
comments.max_depth |
1 | 0 = roots only |
comments.order |
top | Sort order for comment roots |
RSS / Atom (type: rss)
| Field | Default | Notes |
|---|---|---|
feeds |
— | List of {url, name?} |
max_items_per_feed |
50 | 1–500 |
max_total_items |
200 | 1–2000 |
include_content |
true | Include full entry content |
allow_local_files |
false | Permit local-path / file:// feeds |
feeds[].url is restricted to HTTP(S) URLs by default. Setting
allow_local_files: true additionally permits local file paths and file://
URLs — see the security note below before enabling it.
⚠️ Security — untrusted configs. fetchkit is built to run YAML that may be produced by an LLM/agent. With
allow_local_files: true, a config could point a "feed" at an arbitrary local path (e.g.file:///etc/passwd) and surface its contents inpost.text. Local file reads are therefore off by default; enable them only for configs and fixtures you trust. Keep the default (false) when feeding fetchkit configs you did not author.
arXiv (type: arxiv)
Uses the arXiv export API (Atom, parsed with feedparser). Authors, categories, DOI,
PDF link, and primary category are preserved in post.metadata.
| Field | Default | Notes |
|---|---|---|
categories |
[] |
arXiv categories, e.g. ["cs.AI", "cs.LG"] (empty = all) |
query |
null | Free-text query (combined with categories via AND) |
max_items |
50 | 1–500 |
GitHub (type: github)
Public GitHub REST API (no auth; tighter rate limits without a token). Repo,
language, stars, forks, and topics are preserved in post.metadata.
| Field | Default | Notes |
|---|---|---|
resource |
releases | releases (per-repo) or search_repos |
repos |
[] |
owner/name list — required for resource: releases |
query |
null | Search query — required for resource: search_repos |
max_items |
50 | 1–300 |
Lobsters (type: lobsters)
The lobste.rs public JSON endpoints (no auth). Tags are preserved in post.metadata.
| Field | Default | Notes |
|---|---|---|
listing |
hottest | hottest or newest |
tag |
null | Restrict to a single tag (uses /t/<tag>.json) |
max_items |
50 | 1–200 |
HTTP (http:)
| Field | Default | Notes |
|---|---|---|
timeout |
10.0 | Per-request timeout in seconds |
max_retries |
3 | Retries on transient errors (0–10) |
backoff_factor |
0.5 | wait = backoff_factor * 2^attempt seconds |
rate_limit_per_host |
null | Max requests/sec per host (null = disabled) |
retry_statuses |
429,500,502,503,504 | Status codes that trigger a retry |
Adding a fetcher
Fetchers live in the library itself, so each one ships with a typed config, validation, and tests. Add a new source via a PR or a local fork in four steps:
-
Add a typed config to
src/fetchkit/schemas/fetcher.py(subclassFetcherBase, give it aLiteraltype), and register it in_BUILTIN_TYPES+FetcherConfig. -
Write the fetcher module in
src/fetchkit/fetchers/, returning aFetcherResult:from fetchkit.fetchers.base import FetcherResult from fetchkit.fetchers.registry import register_fetcher from fetchkit.schemas.post import Post @register_fetcher("mysource") def fetch(config) -> FetcherResult: posts = [Post(id="1", source="mysource", title="…", source_url="https://…")] return FetcherResult(posts=posts, errors=[])
-
Import the module in
src/fetchkit/fetchers/__init__.pyso it registers on import. -
Add tests (mock HTTP with the
responseslibrary — seetests/fetchers/).
Use Post.metadata for any source-specific fields that don't map to the canonical
columns.
The Post model
class Post(BaseModel):
id: str # unique within source
source: str # "hackernews" | "rss" | "arxiv" | "github" | "lobsters"
title: str | None
text: str | None # body / content
url: str | None # external link
author: str | None
score: int | None
comment_count: int | None
created_at: datetime | None # UTC-aware
source_url: str # direct link on the source platform
comments: list[Comment] # nested threads (HN)
metadata: dict[str, Any] # source-specific extras (categories, stars, tags, …)
All datetimes are normalized to UTC. Posts are deduplicated by (source, id) and
sorted descending by (created_at, id) for deterministic output.
Collector invariants
collect_all preserves three guarantees:
- Window inheritance — per-fetcher
start_time/end_timefall back to the global window when omitted. - Dedup — by
(source, id); first occurrence wins. - Sort — descending by
(created_at or UTC_MIN, id).
Partial failures are aggregated, not fatal: a failing source yields an entry in
result.errors while other sources still collect. Check result.has_errors.
Development
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
# tests (skip live/networked)
pytest -m "not live"
# live network smoke (opt-in)
pytest -m live
# strict typecheck
mypy src
License
MIT — see LICENSE. MIT is intentional: as a small, dependency-light utility meant to be embedded freely in agent pipelines (including commercial and closed-source ones), a permissive license maximizes adoption with no copyleft obligations. A weak-copyleft license (e.g. MPL-2.0) or strong copyleft (GPL/AGPL) would force redistribution terms on downstream users and discourage exactly the embedded use fetchkit is built for.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fetchkit_agents-0.1.0.tar.gz.
File metadata
- Download URL: fetchkit_agents-0.1.0.tar.gz
- Upload date:
- Size: 37.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bc6024eae1285907e998a74a90b24c172b8b32261fa8b6745f4e74d84d79d497
|
|
| MD5 |
9e333edb50ae9a4379d31e62f4738647
|
|
| BLAKE2b-256 |
028110123f55aca537160a8c1791873fdfd4378d16992316bfd22b79c92eb697
|
File details
Details for the file fetchkit_agents-0.1.0-py3-none-any.whl.
File metadata
- Download URL: fetchkit_agents-0.1.0-py3-none-any.whl
- Upload date:
- Size: 41.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
93b9182e646588c283a2349107eec22a3783332202ae1ec00a0d70699894b614
|
|
| MD5 |
e2ebd96c59d94314bda554904b3f1dad
|
|
| BLAKE2b-256 |
76c2f548fc0c2ce96151951c32835b5868a5111fed20248cf1ca652d7da178fa
|