src/sources.py

"""Source registry for Polish DynaWord.

Each entry = one openly-licensed, *traceable* human-text source (paper 2508.02271,
principle: open+traceable licensing). The `traceable` field documents WHY the
license holds (not just "it's public domain") — e.g. statutory basis or upstream
license — as required by the Dynaword guidelines.

Provenance note: data is pulled from SpeakLeash's public redistribution
(iDrive e2 bucket) of these upstream sources; SpeakLeash is credited as the
intermediate aggregator, upstream license/attribution is preserved per source.
"""

# clean-6: passed the copyright review (2026-06-15). open_subtitles excluded
# (derivative of copyrighted film dialogue — same lesson as Danish Gigaword).
# Large cultural/academic sources require per-record rights metadata and should
# be rebuilt from direct upstream/export scripts rather than blind SpeakLeash pulls.
SOURCES = {
    "wikipedia": {
        "speakleash_key": "plwiki",
        "pretty": "Polish Wikipedia",
        "license": "CC-BY-SA-3.0",
        "license_spdx": "CC-BY-SA-3.0",
        "traceable": "Wikimedia dumps explicitly released under CC-BY-SA 3.0; "
                     "attribution to contributors + share-alike preserved.",
        "upstream": "https://dumps.wikimedia.org/plwiki/latest/",
        "domain": "encyclopedic",
        "created": "2001-01-15, 2026-06-14",
        "is_ocr": False,
    },
    "wikisource": {
        "speakleash_key": "plwikisource",
        "pretty": "Polish Wikisource",
        "license": "CC-BY-SA-3.0",
        "license_spdx": "CC-BY-SA-3.0",
        "traceable": "Wikimedia dumps under CC-BY-SA 3.0; underlying texts are "
                     "public-domain works transcribed by the community.",
        "upstream": "https://dumps.wikimedia.org/plwikisource/latest/",
        "domain": "books/source-texts",
        "created": "2005-01-01, 2026-06-14",
        "is_ocr": False,
    },
    "wiktionary_examples": {
        "file_key": "wiktionary_examples",
        "pretty": "Polish Wiktionary usage examples",
        "provenance": "Parsed directly from the official Wikimedia dump "
                      "(plwiktionary-latest-pages-articles.xml.bz2); not routed "
                      "through SpeakLeash. Usage-example sections of Polish-language "
                      "entries extracted and grouped one document per headword.",
        "license": "CC-BY-SA-3.0",
        "license_spdx": "CC-BY-SA-3.0",
        "traceable": "Wikimedia dumps explicitly released under CC-BY-SA 3.0; "
                     "attribution to contributors + share-alike preserved. "
                     "Derived subset: usage-example sections from Polish-language "
                     "entries only, grouped one document per headword.",
        "upstream": "https://dumps.wikimedia.org/plwiktionary/latest/",
        "domain": "lexicographic",
        "created": "2004-03-22, 2026-08-15",
        "is_ocr": False,
    },
    "eurlex": {
        "speakleash_key": "eurlex_corpus",
        "pretty": "EUR-Lex (EU legal acts, Polish)",
        "license": "CC-BY-4.0",
        "license_spdx": "CC-BY-4.0",
        "traceable": "EU documents reusable under Commission Decision 2011/833/EU; "
                     "normative acts fall outside copyright (PL art. 4 pr. aut.). "
                     "Reuse authorised with source acknowledgement.",
        "upstream": "https://eur-lex.europa.eu",
        "domain": "legal",
        "created": "1952-01-01, 2024-12-31",
        "is_ocr": False,
    },
    "parliamentary": {
        "speakleash_key": "PPC_corpus",
        "pretty": "Polish Parliamentary Corpus (Sejm/Senat)",
        "license": "public-domain (official documents)",
        "license_spdx": "CC-BY-4.0",
        "traceable": "Parliamentary proceedings are official documents outside "
                     "copyright (PL art. 4 pr. aut.); PPC redistributed by IPI PAN "
                     "under CC-BY-4.0.",
        "upstream": "http://clip.ipipan.waw.pl/PPC",
        "domain": "political/spoken",
        "created": "1991-01-01, 2019-12-31",
        "is_ocr": False,
    },
    "sejm_api": {
        "file_key": "sejm_api",
        "pretty": "Sejm API parliamentary speeches (2023 onward)",
        "license": "public-domain (official documents)",
        "license_spdx": "LicenseRef-Polish-Official-Documents",
        "traceable": "Official parliamentary materials excluded from copyright "
                     "under Polish Copyright Act art. 4(2); reusable under "
                     "the Polish Open Data Act arts. 2(12), 5, 14 and 17.",
        "upstream": "https://api.sejm.gov.pl/",
        "provenance": "Direct official Sejm API records, preserved with speaker "
                      "attribution and immutable PiotrSty/sejm-speeches-corpus "
                      "v1.0.1 source provenance.",
        "domain": "political/spoken",
        "created": "2023-01-01, 2026-07-03",
        "is_ocr": False,
    },
    "parlamint_pl": {
        "file_key": "parlamint_pl",
        "pretty": "ParlaMint-PL (parliamentary debates, 2015-2022)",
        "license": "CC-BY-4.0",
        "license_spdx": "CC-BY-4.0",
        "traceable": "ParlaMint 3.0 corpora released under CC-BY 4.0 (CLARIN.SI "
                     "handle 11356/1486); parliamentary proceedings are also "
                     "official documents (PL art. 4 pr. aut.).",
        "upstream": "http://hdl.handle.net/11356/1486",
        "provenance": "Fetched directly from the CLARIN.SI plain-text edition "
                      "(ParlaMint-PL.tgz) by src/fetch_parlamint.py; one session "
                      "transcript per document, utterance IDs stripped. Modern "
                      "spoken register, complements the older PPC (1991-2019).",
        "domain": "political/spoken",
        "created": "2015-01-01, 2022-12-31",
        "is_ocr": False,
    },
    "wolne_lektury": {
        "speakleash_key": "wolne_lektury_corpus",
        "pretty": "Wolne Lektury (school readings)",
        "license": "CC-BY-SA-4.0 / Wolna Sztuka 1.3",
        "license_spdx": "CC-BY-SA-4.0",
        "traceable": "Wolne Lektury publishes under CC-BY-SA 4.0 or Free Art "
                     "License; texts are public-domain classics + cleared works.",
        "upstream": "https://wolnelektury.pl/api/books/",
        "domain": "literature",
        "created": "1500-01-01, 2024-12-31",
        "is_ocr": False,
    },
    "wikinews": {
        "file_key": "plwikinews",  # fetched from Wikimedia dumps, NOT via SpeakLeash
        "pretty": "Polish Wikinews",
        "license": "CC-BY-2.5",
        "license_spdx": "CC-BY-2.5",
        "traceable": "Wikinews content is released under CC-BY 2.5; attribution to "
                     "contributors preserved.",
        "upstream": "https://pl.wikinews.org/",
        "provenance": "Fetched directly from the official Wikimedia dump "
                      "(plwikinews-latest-pages-articles) by src/fetch_wikimedia.py; "
                      "mainspace only, wikitext stripped via mwparserfromhell.",
        "domain": "news",
        "created": "2005-01-01, 2025-12-31",
        "is_ocr": False,
    },
    "wikivoyage": {
        "file_key": "plwikivoyage",
        "pretty": "Polish Wikivoyage (travel guides)",
        "license": "CC-BY-SA-3.0",
        "license_spdx": "CC-BY-SA-3.0",
        "traceable": "Wikivoyage content is released under CC-BY-SA 3.0; "
                     "attribution + share-alike preserved.",
        "upstream": "https://pl.wikivoyage.org/",
        "provenance": "Fetched directly from the official Wikimedia dump "
                      "(plwikivoyage-latest-pages-articles) by src/fetch_wikimedia.py; "
                      "mainspace only, wikitext stripped via mwparserfromhell.",
        "domain": "travel",
        "created": "2012-01-01, 2025-12-31",
        "is_ocr": False,
    },
    "wikibooks": {
        "file_key": "plwikibooks",
        "pretty": "Polish Wikibooks (open textbooks)",
        "license": "CC-BY-SA-3.0",
        "license_spdx": "CC-BY-SA-3.0",
        "traceable": "Wikibooks content is released under CC-BY-SA 3.0; "
                     "attribution + share-alike preserved.",
        "upstream": "https://pl.wikibooks.org/",
        "provenance": "Fetched directly from the official Wikimedia dump "
                      "(plwikibooks-latest-pages-articles) by src/fetch_wikimedia.py; "
                      "mainspace only, wikitext stripped via mwparserfromhell.",
        "domain": "instructional",
        "created": "2004-01-01, 2025-12-31",
        "is_ocr": False,
    },
    "wikiquote": {
        "file_key": "plwikiquote",
        "pretty": "Polish Wikiquote (quotations)",
        "license": "CC-BY-SA-3.0",
        "license_spdx": "CC-BY-SA-3.0",
        "traceable": "Wikiquote content is released under CC-BY-SA 3.0; "
                     "attribution + share-alike preserved.",
        "upstream": "https://pl.wikiquote.org/",
        "provenance": "Fetched directly from the official Wikimedia dump "
                      "(plwikiquote-latest-pages-articles) by src/fetch_wikimedia.py; "
                      "mainspace only, wikitext stripped via mwparserfromhell.",
        "domain": "quotations",
        "created": "2005-01-01, 2025-12-31",
        "is_ocr": False,
    },
    "eltec_pol": {
        "file_key": "eltec_pol",
        "pretty": "ELTeC-pol (European Literary Text Collection, Polish)",
        "license": "CC-BY-4.0",
        "license_spdx": "CC-BY-4.0",
        "traceable": "ELTeC corpora are released under CC-BY 4.0 by the COST Action "
                     "'Distant Reading for European Literary History' (CA16204).",
        "upstream": "https://github.com/COST-ELTeC/ELTeC-pol",
        "provenance": "Fetched directly from the COST-ELTeC/ELTeC-pol GitHub "
                      "repository (level1 TEI) by src/fetch_eltec.py; reading text "
                      "extracted from TEI <body> paragraphs.",
        "domain": "literature",
        "created": "1840-01-01, 1920-12-31",
        "is_ocr": False,
    },
    "dziennik_ustaw": {
        "file_key": "dziennik_ustaw",  # fetched directly, NOT via SpeakLeash
        "pretty": "Dziennik Ustaw + Monitor Polski (Polish primary legislation)",
        "license": "public-domain (official documents)",
        "license_spdx": "CC0-1.0",
        "traceable": "Normative acts and their official drafts are not subject to "
                     "copyright (PL art. 4 ustawy o prawie autorskim). Published by "
                     "the state; reuse unrestricted.",
        "upstream": "https://api.sejm.gov.pl/eli/acts",
        "provenance": "Fetched directly from the Sejm ELI API (text.html per act) "
                      "by src/fetch_eli.py — a native source, not redistributed via "
                      "SpeakLeash. Full provenance: each act's `meta.url` is its ELI "
                      "address, resolvable on api.sejm.gov.pl.",
        "domain": "legal",
        "created": "1918-01-01, 2025-12-31",
        "is_ocr": False,
    },
    "govpl": {
        "file_key": "govpl",  # fetched directly from gov.pl, NOT via SpeakLeash
        "pretty": "gov.pl — Polish government press releases",
        "license": "CC-BY-SA-4.0",
        "license_spdx": "CC-BY-SA-4.0",
        "traceable": "All textual content on gov.pl is published under CC-BY-SA "
                     "4.0 (site footer: \"Treści tekstowe publikowane w serwisie "
                     "… są udostępniane na licencji CC BY-SA 4.0\"). Authored and "
                     "hosted by the Polish government, which holds the right to "
                     "license it — same open family as Polish Wikipedia.",
        "upstream": "https://www.gov.pl/",
        "provenance": "Ministry/agency press releases fetched directly from gov.pl "
                      "(editor-content per article, HTML stripped) by "
                      "src/fetch_govpl.py. Subsites + their non-uniform news-section "
                      "paths are enumerated by src/discover_govpl.py into the "
                      "committed manifest src/govpl_subsites.json (gov.pl has no "
                      "sitemap/API). Each record's meta.url resolves on gov.pl.",
        "domain": "government",
        # actual min/max of article dates in the fetched corpus (90,124 dated).
        "created": "2005-09-26, 2026-07-19",
        "is_ocr": False,
    },
    "samorzad_gov_pl": {
        "file_key": "samorzad_gov_pl",
        "pretty": "samorzad.gov.pl — Polish public-sector institutions",
        "license": "CC-BY-SA-4.0",
        "license_spdx": "CC-BY-SA-4.0",
        "traceable": "The shared samorzad.gov.pl platform footer publishes textual "
                     "content under CC BY-SA 4.0. Every retained v0.1 source page "
                     "referenced the shared footer script; audiovisual media and "
                     "attachment bytes are not redistributed.",
        "upstream": "https://huggingface.co/datasets/dawidmajewski/samorzad-gov-pl-articles",
        "provenance": "Converted reproducibly from the published v0.1 source dataset "
                      "by src/clean_samorzad_gov_pl.py. The source was collected "
                      "directly from public samorzad.gov.pl pages across 246 local "
                      "public institutions and one central platform tenant. "
                      "Institution display names are frozen "
                      "from each tenant homepage's og:site_name metadata and stored "
                      "as DynaWord author values; discovered, fetched and attribution "
                      "URLs plus license details are preserved in the sidecar.",
        "domain": "local government, education, social services and culture",
        "created": "2020-2026 for 21,892 dated records; 59,530 source records undated",
        "is_ocr": False,
        "custom_datasheet": True,
    },
    "biblioteka_nauki": {
        "file_key": "biblioteka_nauki_pl_corpus",
        "pretty": "Biblioteka Nauki",
        "license": "per-record upstream license",
        "license_spdx": "MIXED",
        "traceable": "Documents are accepted only when the direct upstream record "
                     "exposes a reusable license. The parquet carries the "
                     "per-document `license` and `author` fields from the upstream "
                     "metadata collected by the source-specific rebuild script.",
        "upstream": "https://bibliotekanauki.pl/",
        "provenance": "Fetched directly from Biblioteka Nauki via the contributor "
                      "rebuild script, not from the SpeakLeash redistribution. "
                      "License and author metadata are checked document by document "
                      "before normalization into the DynaWord schema.",
        "domain": "academic",
        "created": "unknown",
        "is_ocr": False,
    },
    "europeana": {
        # Direct rebuild output from fetch_europeana.py, never the raw
        # SpeakLeash Europeana aggregate.
        "file_key": "europeana",
        "pretty": "Europeana Polish records",
        "license": "per-record public-domain/open rights statement",
        "license_spdx": "MIXED",
        "traceable": "Documents are accepted only with per-record Europeana rights "
                     "metadata classified as public-domain/open. Public-domain "
                     "status is jurisdiction-sensitive; downstream users must "
                     "check their local legal requirements.",
        "upstream": "https://www.europeana.eu/",
        "provenance": "Fetched directly from Europeana via the contributor rebuild "
                      "script, preserving per-record rights and creator metadata. "
                      "The raw SpeakLeash aggregate remains insufficient because "
                      "it does not carry enough rights evidence for release.",
        "domain": "cultural heritage",
        "created": "unknown",
        "is_ocr": True,
        "legal_note": "Europeana public-domain statements are primarily evaluated "
                      "for Poland/EU. For US reuse, records created/published "
                      "before 1929 are the conservative release slice; later "
                      "records should remain separately labeled or held until "
                      "legal review confirms their US status.",
    },
    "nkjp1m": {
        "file_key": "nkjp1m",
        "pretty": "The manually annotated 1-million word subcorpus of the National Corpus of Polish",
        "license": "CC-BY",
        "license_spdx": "CC-BY-4.0",
        "traceable": "The NKJP download page (clip.ipipan.waw.pl) states the manually annotated 1-million-word subcorpus (Podkorpus Milionowy NKJP 1.2) is available under a CC-BY licence; attribution to the NKJP Consortium (IPI PAN) preserved. The page states 'CC-BY' with no version, normalized to CC-BY-4.0 for SPDX. The CC-BY licence covers the corpus text; NKJP's separate tools are GPL and are not included here.",
        "upstream": "https://clip.ipipan.waw.pl/NationalCorpusOfPolish",
        "provenance": "Downloaded the IPI PAN tarball (NKJP-PodkorpusMilionowy-1.2.tar.gz) directly by src/fetch_njkp.py, one row per TEI <div> passage (its <ab> paragraphs joined by newlines, ellipsis markers stripped). The same minimal gates as build_dynaword.py are applied per passage (drop < 200 chars, drop non-Polish by diacritic ratio, exact sha1 dedup; the OCR gate is inapplicable). Per-document 'created' is the sample's TEI publication date (<date type=\"published\">) where the header records one. Normalized into the DynaWord schema; cl100k token counts via tiktoken (encode_ordinary), and the stats are recomputed from the written parquet.",
        "domain": "mixed (balanced reference corpus)",
        "created": "1957-2008 (recorded for 6,581 of 18,381 documents; per-document in the created column)",
        "is_ocr": False,
    },
    "european_hplt_v3_pl": {
        "file_key": "european_hplt_v3_pl",
        "pretty": "HPLT v3.0 Polish (web, top WDS bins 10-5)",
        "license": "CC0-1.0",
        "license_spdx": "CC0-1.0",
        "traceable": "HPLT v3.0 Terms of Use license the data packaging under CC0-1.0 "
                     "(hplt-project.org/datasets/v3.0; HF card HPLT/HPLT3.0). HPLT does not "
                     "own the underlying web text; notice-and-takedown applies and downstream "
                     "legal/provenance review remains the user's responsibility.",
        "upstream": "https://data.hplt-project.org/three/sorted/pol_Latn/",
        "provenance": "Fetched directly from the HPLT v3 distribution (pol_Latn shards "
                      "10_1, 9_1-9_4, 8_1-8_4, 7_1-7_4, 6_1-6_2, 5_1-5_2 [WDS 10 down to 5]) by "
                      "src/clean_hplt_v3.py + run_pipeline.py, NOT via SpeakLeash. Filtered: "
                      "lang=pol_Latn + prob>=0.80, MT-prob<0.20, register in ID/OP/HI/IN/NA, "
                      "min 400 chars / 80 words, boilerplate/adult/legalish drop, length cap "
                      "120k chars, CJK-mojibake drop, wikipedia/wikisource/wikimedia + file-host "
                      "domains excluded, per-domain cap. Phone->[Telefon] / email+national-ID->[PII] "
                      "PII-scrub (v12b, independent dual-lens verify). Token counts via tiktoken cl100k.",
        "domain": "web",
        "created": "2012-01-01, 2024-12-31",
        "is_ocr": False,
        "legal_note": "Web-crawl derived: accept_after_web_review. HPLT is globally "
                      "deduplicated upstream and WDS quality-sorted. Cross-source near/"
                      "containment dedup vs the existing WDS-10+9 base shards was performed "
                      "for the WDS 8-5 + extra-9 expansion: exact-dup=0, near-dup overlap="
                      "0.0000% (byte-verified). Copyright recurs at all lengths in web crawl. "
                      "Parity with the accepted european-hplt-v1 CC0 basis.",
        "custom_datasheet": True,
    },
    "1000_novels": {
        "speakleash_key": "1000_novels_corpus_CLARIN-PL",
        "pretty": "1000 Novels Corpus (CLARIN-PL)",
        "license": "CC-BY-4.0",
        "license_spdx": "CC-BY-4.0",
        "traceable": "The 1000 Novels Corpus is released under Creative Commons "
                     "Attribution 4.0 International by CLARIN-PL / Wrocław University "
                     "of Technology, with attribution to the corpus authors and "
                     "maintainers.",
        "upstream": "https://clarin-pl.eu/dspace/handle/11321/312",
        "domain": "literature",
        "created": "unknown",
        "is_ocr": False,
        # Datasheet is contributor-committed (added 2026-07-02); skip regeneration
        # so the global ADDED stamp does not overwrite the real add date.
        "custom_datasheet": True,
    },
    "global_voices": {
        # Data contributed directly (PR #7): no in-repo fetch/build script and a
        # hand-authored datasheet. Registered for the source table + release totals;
        # the datasheet stays contributor-owned via custom_datasheet.
        "file_key": "global_voices",
        "pretty": "Global Voices Polish",
        "license": "CC-BY-3.0",
        "license_spdx": "CC-BY-3.0",
        "traceable": "CC BY 3.0 verified from the article-level license link published "
                     "with each retained Global Voices article; each record carries "
                     "CC-BY-3.0 metadata and per-document author/translator attribution "
                     "in global_voices.attribution.jsonl.",
        "upstream": "https://pl.globalvoices.org/",
        "domain": "civic media, news and public-interest journalism",
        "created": "2008-11-04, 2023-05-24",
        "is_ocr": False,
        "custom_datasheet": True,
    },
}

ADDED = "2026-07-19"
EXCLUDED = {
    "open_subtitles_corpus": "Derivative of copyrighted film/TV dialogue; "
        "OpenSubtitles uploads largely unlicensed. Same copyright lesson as "
        "Danish Gigaword's OpenSubtitles (paper 2508.02271). Not openly licensed.",
    "europeana_eu_pl_corpus_raw_speakleash": "Aggregated items with mixed "
        "per-record rights (PD / CC-BY-NC / rights-reserved). The raw "
        "SpeakLeash redistribution is excluded; only a direct rebuild preserving "
        "per-record rights metadata may be included.",
    "1000_novels_corpus_CLARIN-PL": "CC-BY-4.0 label, but 'novels' likely include "
        "in-copyright contemporary works; verify titles/years on CLARIN handle "
        "11321/312 before inclusion.",
    "project_gutenberg_pl_corpus": "Only 31 PL books (4.3MB) — PG is ~99% English; "
        "Polish PD literature already covered by wolne_lektury + wikisource (so "
        "near-redundant after dedup). Dropped to avoid the PD-in-EU per-work check "
        "(PG claims PD-in-US only) for negligible token gain.",
}