kglite 0.10.22

Pure-Rust knowledge graph engine — Cypher pipeline, snapshot/working CoW transactions, columnar/mmap/disk storage backends, optional dataset loaders (SEC EDGAR, Sodir, Wikidata). PyO3 wrappers live in the sibling kglite-py crate (the Python wheel); embeddable directly from any Rust binary without PyO3 in the dep tree.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! SEC EDGAR URL templates and constants.
//!
//! Centralised so the rest of the crate only knows abstract resources
//! (`quarterly_master_idx_url(2024, 4)`), never raw URL strings.
//! Single source of truth for endpoint changes.

/// EDGAR's primary file-server base.
pub const EDGAR_BASE: &str = "https://www.sec.gov/";

/// data.sec.gov is the JSON API surface (submissions, XBRL frames).
pub const DATA_SEC_BASE: &str = "https://data.sec.gov/";

/// SEC's mandated rate-limit ceiling. The token bucket is sized at this.
pub const RATE_LIMIT_PER_SEC: u32 = 10;

/// Quarterly master.idx file — one per (year, quarter) since 1993 Q3.
/// Fully populated for closed quarters; live-updated for the current
/// quarter.
pub fn quarterly_master_idx_url(year: u16, quarter: u8) -> String {
    debug_assert!((1..=4).contains(&quarter));
    debug_assert!(year >= 1993);
    format!("{EDGAR_BASE}Archives/edgar/full-index/{year}/QTR{quarter}/master.idx")
}

/// Daily company.YYYYMMDD.idx file — same schema as master.idx, one
/// day's filings. Used only for incremental rebuilds.
pub fn daily_company_idx_url(year: u16, quarter: u8, date_yyyymmdd: u32) -> String {
    debug_assert!((1..=4).contains(&quarter));
    format!(
        "{EDGAR_BASE}Archives/edgar/daily-index/{year}/QTR{quarter}/company.{date_yyyymmdd}.idx"
    )
}

/// Nightly bulk submissions ZIP. Contains one JSON per CIK in the form
/// `CIK0000320193.json`.
pub fn submissions_bulk_url() -> &'static str {
    "https://www.sec.gov/Archives/edgar/daily-index/bulkdata/submissions.zip"
}

/// Per-CIK submissions JSON (alternative to the bulk ZIP).
pub fn submissions_cik_url(cik: u64) -> String {
    format!("{DATA_SEC_BASE}submissions/CIK{cik:010}.json")
}

/// Per-CIK XBRL company facts JSON.
pub fn companyfacts_url(cik: u64) -> String {
    format!("{DATA_SEC_BASE}api/xbrl/companyfacts/CIK{cik:010}.json")
}

/// Ticker → CIK mapping. ~12K rows in one JSON.
pub fn company_tickers_url() -> &'static str {
    "https://www.sec.gov/files/company_tickers.json"
}

/// Per-filing directory index — the landing page for a specific accession.
/// Used as the base for fetching Exhibit 21 / 8-K payloads.
pub fn filing_index_url(cik: u64, accession_no_dashes: &str) -> String {
    format!("{EDGAR_BASE}Archives/edgar/data/{cik}/{accession_no_dashes}/")
}

/// Convert a dashed accession (`0000320193-24-000123`) to the
/// dash-free form (`000032019324000123`) used as a directory name in
/// EDGAR file paths.
pub fn accession_no_dashes(accession: &str) -> String {
    accession.replace('-', "")
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn quarterly_idx_url_well_formed() {
        let url = quarterly_master_idx_url(2024, 4);
        assert_eq!(
            url,
            "https://www.sec.gov/Archives/edgar/full-index/2024/QTR4/master.idx"
        );
    }

    #[test]
    fn daily_idx_url_well_formed() {
        let url = daily_company_idx_url(2024, 4, 20241115);
        assert_eq!(
            url,
            "https://www.sec.gov/Archives/edgar/daily-index/2024/QTR4/company.20241115.idx"
        );
    }

    #[test]
    fn submissions_cik_url_zero_pads() {
        assert_eq!(
            submissions_cik_url(320193),
            "https://data.sec.gov/submissions/CIK0000320193.json"
        );
    }

    #[test]
    fn companyfacts_url_zero_pads() {
        assert_eq!(
            companyfacts_url(789019),
            "https://data.sec.gov/api/xbrl/companyfacts/CIK0000789019.json"
        );
    }

    #[test]
    fn accession_dashes_stripped() {
        assert_eq!(
            accession_no_dashes("0000320193-24-000123"),
            "000032019324000123"
        );
    }
}