octocrawl-client (Python)

Python client for the Octocrawl API: web pages as Markdown, tables and JSON, each page with its Evidence Record (final URL, fetch time, HTTP status, robots.txt decision, hashes of what was read and delivered), into pandas.

pip install 'octocrawl-client[pandas]'
npx octocrawl serve       # a local Octocrawl API on http://127.0.0.1:8787

import octocrawl_client

result = octocrawl_client.batch(
    ["https://books.toscrape.com/", "https://quotes.toscrape.com/"],
    formats=["markdown", "tables"],
)
df = result.to_pandas()          # one row per page
df[["url", "status", "fetched_at", "http_status", "raw_sha256"]]
result.report["succeeded"], result.report["failed"]

to_pandas() has one row per page, failed pages included, with these columns: url, status, reason, final_url, fetched_at, http_status, lane, robots_decision, raw_sha256, markdown_sha256, extractor, source_commit, cache_state, cached_at and markdown. A value Octocrawl did not observe is missing (None, or <NA> for http_status), never 0. result.items keeps each page as the API answered it, its tables (formats=["tables"]) and full evidenceRecord included.

Options take the API's names in snake_case or camelCase: max_age=3_600_000, only_main_content=False, include_tags=["main"], parsers=[{"type": "pdf", "maxPages": 5}]. W2L(base_url=..., token=...) names another API (default W2L_API_URL, else http://127.0.0.1:8787; W2L_API_TOKEN). A batch takes up to 1,000 URLs; octocrawl_client.scrape, octocrawl_client.map and octocrawl_client.crawl work the same way. (The name octocrawl on PyPI belongs to another project.)

Licence: MIT. Source and the API reference: https://github.com/77777R7/Octocrawl