Skip to content

OpenAPI and Environment info in README #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brian-learns merged 1 commit into from
Aug 2, 2026
Merged

OpenAPI and Environment info in README #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# `ccnget` -- common crawl news get

Search over 1.4 Billion archived news URLs from CC-NEWS and retrieve contents from WARC files.

`/lookup?` Endpoint OpenAPI: [🛠️ Try it out (swagger)](https://brian-learns-cc-news-cdx-server.hf.space/docs#/default/lookup_endpoint_lookup_get) | [📖 Redoc](https://brian-learns-cc-news-cdx-server.hf.space/redoc) | [📄 OpenAPI JSON](https://brian-learns-cc-news-cdx-server.hf.space/openapi.json) | [🤗 Hugging Face Space](https://huggingface.co/spaces/brian-learns/cc-news-cdx-server)

## Quickstart
Running the command
```bash
Expand Down Expand Up @@ -64,6 +68,16 @@ Lookup and retrieve the first result in one step:
uv run ccnget fetch "http://example.com" -o article.html
```

## Environment

* **`CDX_LOOKUP_URL`** The URL for the CDX server lookup.
* Default: *`https://brian-learns-cc-news-cdx-server.hf.space/lookup`*
* **`CC_CRAWL_BASE_URL`** The base URL for downloading Common Crawl data.
* Default: *`https://data.commoncrawl.org`*

These variables can be set directly in your shell environment or defined
in a local *.env* file.

## Diagram

While most of this was vibe coded, I drew this architecture diagram in monodraw and came up with the basic approach. Numbers are as of the first test retrospective build. I'm not sure if I'm going to do prospective maintenance.
Expand Down
Loading