kaos-citations 0.1.0a1__tar.gz

kaos_citations-0.1.0a1/.gitignore

@@ -0,0 +1,19 @@
+.coverage
+.pytest_cache/
+.ruff_cache/
+.venv/
+__pycache__/
+*.py[cod]
+dist/
+build/
+.env
+.env.test
+.env.local
+# Per F009 lesson #4: uv.lock is gitignored at v0.1 of any package
+# whose dev-group references unpublished siblings. Re-track at 0.1.0a2
+# once kaos-mcp ships and is added to the dev group.
+uv.lock
+
+# Per F009 lesson: uv.lock gitignored at v0.1 because dev group
+# references kaos-mcp / unpublished siblings. Re-track at 0.1.0a2.
+uv.lock

kaos_citations-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,133 @@
+# Changelog
+
+All notable changes to `kaos-citations` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0a1] — 2026-05-07
+
+First public alpha release.
+
+### Added
+
+- **`extract_citations(text, *, kinds=None, source_uri=None)`** — top-
+  level dispatcher across **60 supported `kind` literals** spanning
+  four domains:
+  - **Legal** (25 kinds): full-form + short-form case law (`case` /
+    `case_short` / `id` / `supra` / `case_ref`), journal articles
+    (`journal`), CFR, U.S. Code / I.R.C. / state codes (`statute`),
+    Federal Register, U.S. Constitution, Federal Rules + USSG, Treasury
+    Regulations, IRS guidance (Rev. Rul. / Rev. Proc. / Notice / PLR /
+    TAM / GCM / FSA / CCA / T.D. / IRB / IRM), executive actions
+    (E.O. / Proc. / Memo / Determination), public laws + bills +
+    reports + Cong. Rec., Restatements, Uniform Acts + Model Codes,
+    agency adjudications (NLRB / FERC / FCC / FTC / NTSB / EPA EAB /
+    BIA / PTAB / TTAB), agency manuals (MPEP / TMEP / POMS), AG / OLC
+    opinions, bar ethics opinions, internet URLs, archive URLs.
+  - **Financial** (19 kinds): SEC filings (20+ form types), SEC
+    releases (33-/34-/IC-/IA-/TIA-), SEC staff guidance (SAB / SLB /
+    C&DI / no-action), SEC named regulations (Reg. S-X / S-K / G /
+    AB / M / FD / BTR / S-T), FINRA rules + notices + disciplinary,
+    exchange rules (NYSE / Nasdaq / Cboe / MSRB / OCC), Federal
+    Reserve regs + SR/CA/OP letters, FDIC FILs, OCC bulletins +
+    interpretive letters + conditional approvals, CFPB bulletins +
+    circulars + advisory opinions, NCUA letters, Basel framework,
+    CFTC interpretive + no-action + advisory + orders, NAIC
+    bulletins + model acts, international finance bodies (FATF /
+    IOSCO), FFIEC call reports.
+  - **Accounting** (13 kinds): FASB ASC + ASU + legacy (FAS / FIN /
+    FSP / EITF / TB / CON / APB / ARB), PCAOB AS + Releases + Rules
+    + Practice Alerts, AICPA SAS / SSAE / SSARS / SOP / TQA / Code,
+    IFRS family (IFRS / IAS / IFRIC / SIC / Practice Statement /
+    Conceptual Framework), IAASB (ISA / ISAE / ISRE / ISRS / ISQM /
+    ISQC), IESBA Code, GASB Statements + Implementation Guides +
+    Concepts + Tech Bulletins + Interpretations, FASAB SFFAS +
+    Concepts + Interpretations + Tech Bulletins, government audit
+    (OMB Circulars + Memos + GAO Reports + Yellow Book), NAIC SSAP,
+    sustainability frameworks (GRI / SASB / TCFD / ISSB / ESRS).
+  - **Identifier** (3 kinds): DOI, PubMed, arXiv (opt-in by default).
+- **Three MCP tools** (`kaos-citations-extract`, `kaos-citations-validate`,
+  `kaos-citations-doctor`) — registered via
+  `register_citations_tools(runtime)`. All read-only, fully offline.
+  `kaos-citations-validate` rejects unknown `expected_kind` values
+  upfront with an error and near-match suggestions.
+- **One MCP resource** — `kaos-citations://kinds` — static taxonomy
+  agents read for self-discovery: every `kind`, the broader family
+  (`legal` / `financial` / `accounting` / `identifier`), a Bluebook-
+  style example, and an `opt_in` flag. Registered via
+  `register_citations_resources(runtime)`. Unit tests cross-check the
+  table against the dispatcher's `_SUPPORTED_KINDS` so they cannot drift.
+- **Typed `Citation` discriminated union** with frozen Pydantic
+  models per family — every `model.__all__` symbol is re-exported
+  from the package surface (`from kaos_citations import IFRSCitation`,
+  `SECFilingCitation`, `AgencyAdjudicationCitation`, etc.).
+  Citations carry stable provenance (`raw` / `normalized` / `span` /
+  `source_uri`), a per-extraction `cite_id` (`c0001`, `c0002`, ...),
+  and Bluebook-modifier fields on the base class: `signal`,
+  `pin_cite`, `pin_cite_kind`, `parenthetical`, `parenthetical_kind`,
+  `weight`, `back_ref`, `string_cite_group`, `subsequent_history`.
+- **Stable cite-id cross references** — `back_ref` and the second
+  tuple element of `subsequent_history` reference other citations by
+  their `cite_id` (string), not by list index. Filtering or
+  re-sorting the result list never breaks the cross-references.
+- **Bluebook-correct case parenthetical handling** — date parens
+  (`(1954)`, `(5th Cir. 1996)`) populate `year` and `court` only;
+  weight parens (`(per curiam)` / `(en banc)`) populate `weight`;
+  judge parens (`(Sotomayor, J., dissenting)`) populate `judges`.
+  Only Bluebook R1.5 explanatory text spills into `parenthetical`.
+  Multi-paren chains like `(2014) (per curiam) (holding ...)` are
+  parsed correctly across all three slots.
+- **Bluebook-correct case-name boundaries** — when extracting cite
+  N+1, the case-name walk-back is floored at cite N's right edge.
+  R10.7 subsequent-history connectors (`overruled by`, `aff'd`,
+  `rev'd`, `vacated`, `cert. denied`, etc.) are stripped from the
+  leading edge, so `Roe v. Wade, ..., overruled by Dobbs v. Jackson`
+  yields two clean `case_name` values rather than swallowing the
+  prior cite into the second.
+- **kaos-nlp-core integration boundary** (`kaos_citations._nlp`):
+  `get_sentence_tokenizer()` returns the singleton Punkt tokenizer
+  initialized with the bundled legal model (~27,000 abbreviations).
+  Loader fails loudly via `PunktModelMissingError` if the embedded
+  model is missing or the abbreviation count is below threshold —
+  no silent fallback to an empty tokenizer.
+- **`kaos_citations.matchers`** — single source of truth for all
+  matching: `regex(...)` (Rust regex), `multi_pattern(...)`
+  (Aho-Corasick), `tokenize_words(...)`, `sentence_tokenizer()`,
+  plus `FstSet` builders for reporters / courts / case-name
+  abbreviations / journals / statute reporters / US states.
+- **Vendored data** — `reporters_db` and `courts_db` JSON ship under
+  `kaos_citations/data/` with the upstream BSD-2 license preserved
+  in `kaos_citations/data/LICENSE.vendored`. The runtime consumes
+  the JSON only; no upstream Python code is imported.
+- **Bluebook post-processing passes** (`kaos_citations.postprocess`):
+  cite-id assignment, signal binding (R1.2), string-cite grouping
+  (R1.4), and subsequent-history detection (R10.7), all anchored to
+  Punkt-derived sentence boundaries.
+- **`KaosCitationsSettings`** — `ModuleSettings` subclass with env
+  prefix `KAOS_CITATIONS_` (empty at this release; reserved).
+- **Typed error hierarchy** rooted at
+  `KaosCitationsError(KaosCoreError)`: `CitationParseError`.
+
+### Notes
+
+- The runtime dependency graph is exactly two packages: `kaos-core`
+  (logging + settings + MCP tool primitives) and `kaos-nlp-core`
+  (matching + Punkt + tokenization). No `httpx`, no `eyecite`, no
+  `re`-module imports anywhere in the runtime.
+- `kaos-citations` does NOT do citation resolution (URL building,
+  body fetching) or claim verification. Those responsibilities live
+  in the rest of the KAOS stack — `kaos-source` for typed source
+  connectors, `kaos-web` for generic search + fetch, `kaos-llm-core`
+  for in-process `Cited[T]` grounding, and `kaos-agents` for
+  orchestration. Compose them with the typed citations this package
+  produces.
+- `kaos-mcp` is intentionally absent from extras at 0.1.0a1 — Wave 3,
+  not yet on PyPI. The MCP server entry point will work once
+  `kaos-mcp` publishes; until then, install `kaos-mcp` from source
+  alongside `kaos-citations`.
+
+[Unreleased]: https://github.com/273v/kaos-citations/compare/v0.1.0a1...HEAD
+[0.1.0a1]: https://github.com/273v/kaos-citations/releases/tag/v0.1.0a1

kaos_citations-0.1.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 273 Ventures LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

kaos_citations-0.1.0a1/NOTICE

@@ -0,0 +1,35 @@
+kaos-citations
+Copyright 2026 273 Ventures LLC.
+
+This product includes software developed at 273 Ventures LLC
+(https://273ventures.com).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file
+distributed with this software for the full text of the license.
+
+----------------------------------------------------------------------
+Third-party data
+----------------------------------------------------------------------
+
+This product includes vendored JSON data from two open-source projects
+maintained by the Free Law Project, distributed under the BSD 2-Clause
+License. The data files live in ``kaos_citations/data/``; the upstream
+license texts are reproduced verbatim in
+``kaos_citations/data/LICENSE.vendored``.
+
+  * reporters_db
+    Source: https://github.com/freelawproject/reporters-db
+    Files:  reporters.json, case_name_abbreviations.json,
+            state_abbreviations.json, laws.json, journals.json,
+            regexes.json
+    Copyright (c) 2014, Free Law Project
+    License: BSD 2-Clause
+
+  * courts_db
+    Source: https://github.com/freelawproject/courts-db
+    Files:  courts.json, courts_states.json, courts_variables.json
+    Copyright (c) 2020, Free Law Project
+    License: BSD 2-Clause
+
+kaos-citations consumes these data files only — no Python code from
+either upstream project is imported by the runtime.