02-overview

Chapter 2 — Project Overview

What ratcrate-core Does

1. Reads the crates.io sparse index
2. Identifies crates that depend on ratatui
3. Fetches metadata from the crates.io HTTP API
4. Applies intelligent multi-day caching
5. Produces the final ratcrate.json dataset

High-Level Pipeline

flowchart TD
    A[Sparse Index] --> B(Find Ratatui Dependents)
    B --> C{Index Cache Check}
    C -->|Needs Fetch| D[Fetch from crates.io]
    C -->|Fresh/Hit| E[Load from Metadata Cache]
    D --> F[Update Caches]
    E --> F
    F --> G[Generate ratcrate.json]

Inputs and Outputs

Input:

• Local clone of crates.io sparse index

• Crates.io HTTP API

Output:

output/ratcrate.json

Screenshot running the tool