omnist 0.2.0__tar.gz

omnist-0.2.0/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 reasonable and customary use in 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 [yyyy] [name of copyright owner]
+
+   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.

omnist-0.2.0/NOTICE

@@ -0,0 +1,15 @@
+omnist
+Copyright 2026 Thomas Y. Lee
+
+This product includes software developed by Thomas Y. Lee.
+
+The schema model is inspired by the models and algorithms described in:
+  Thomas Y. Lee and David W. Cheung,
+  "XML Schema Computations: Schema Compatibility Testing and Subschema
+  Extraction", CIKM 2010.
+The library uses a simplified, practical data model rather than the paper's
+formal automaton vocabulary.
+
+The paper PDF bundled at docs/paper/ is Copyright 2010 ACM and is included
+for reference only; it is not covered by the Apache License governing this
+software.

omnist-0.2.0/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: omnist
+Version: 0.2.0
+Summary: One data model, many formats: read, validate, and write JSON, YAML, TOML, XML, and OML.
+Author: Thomas Y. Lee
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/tomlee/omnist
+Project-URL: Repository, https://github.com/tomlee/omnist
+Project-URL: Issues, https://github.com/tomlee/omnist/issues
+Project-URL: Changelog, https://github.com/tomlee/omnist/blob/master/CHANGELOG.md
+Keywords: schema,validation,json,yaml,toml,xml,data,convert
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Provides-Extra: yaml
+Requires-Dist: pyyaml; extra == "yaml"
+Provides-Extra: toml
+Requires-Dist: tomli_w; extra == "toml"
+Provides-Extra: xml
+Requires-Dist: defusedxml; extra == "xml"
+Provides-Extra: all
+Requires-Dist: pyyaml; extra == "all"
+Requires-Dist: tomli_w; extra == "all"
+Requires-Dist: defusedxml; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
+Requires-Dist: tomli_w; extra == "dev"
+Requires-Dist: defusedxml; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: hypothesis; extra == "dev"
+Dynamic: license-file
+
+# Omnist
+
+[![tests](https://github.com/tomlee/omnist/actions/workflows/test.yml/badge.svg)](https://github.com/tomlee/omnist/actions/workflows/test.yml)
+[![python](https://img.shields.io/badge/python-3.11%2B-blue)](#installation)
+[![license](https://img.shields.io/badge/license-Apache--2.0-lightgrey)](LICENSE)
+[![status](https://img.shields.io/badge/status-alpha-orange)](#status)
+
+**Omnist** ("omni-structure") is **one canonical data model for JSON, YAML,
+TOML, XML, and its own native OML (Omnist Markup Language)** — read any of
+them into a single tree, validate it against a schema, compare schema
+versions, and write it back out to any of the others.
+
+```python
+from omnist import parse_schema, doc
+
+s = parse_schema('''
+    record Member { "name": string, "role": string }
+    record Team   { "name": string, "members" [1,]: Member }
+    root Team
+''')
+
+s.validate(doc({"name": "Platform",
+                "members": [{"name": "Ann", "role": "dev"}]})).ok    # True
+```
+
+## Why Omnist
+
+If your service handles config or payloads in more than one format, you usually
+get a different library — and a different mental model — for each. Omnist
+gives you **one** model and **one** schema language over it, grounded in a small,
+self-contained formal model (inspired by Lee & Cheung, CIKM 2010):
+
+- A **Document** is a *tree* — an ordered list of labeled edges. Arrays are
+  just repeated labels, so the *same* Document represents JSON, YAML, TOML,
+  XML (including its interleaved repeated elements), and [OML](docs/formats/oml.md)
+  — Omnist's own format, the only one with zero loss in either direction.
+- A **Schema** is named `record` definitions (closed named fields, each with a
+  cardinality), where every field's type is always exactly one fixed scalar
+  (optionally nullable) or one `Ref` to a named record — referenced by name for
+  reuse and recursion. **Validate** a Document, **compare** two schemas for
+  backward-compatibility, or **infer** a schema from examples.
+- **Restrictive by default** — a schema guarantees structure; there are no
+  structureless escape hatches, and scalar types are never composed.
+
+The model is defined formally in
+[docs/design/model.md](docs/design/model.md); see
+[the quickstart](docs/quickstart.md) for the shortest possible example, or
+[the user guide](docs/guide.md) for the practical tour.
+
+## A 60-second tour
+
+```python
+from omnist import Doc, parse_schema, infer, doc, read_json
+
+# OML is omnist's own format -- see docs/formats/oml.md
+Doc.from_oml('id: 1\ntags: "a"\ntags: "b"\n').to_oml()
+
+# converting from other formats is just read one, write another
+Doc.from_json('{"id": 1, "tags": ["a", "b"]}').to_yaml()
+
+# describe a shape and check data against it; errors carry exact paths
+s = parse_schema('record R { "id": integer, "tags" [0,]: string }\nroot R')
+print(s.validate(doc({"id": "x", "tags": ["a"]})))
+#   invalid:
+#     at $.id: expected integer, got string ('x')
+
+# learn a schema from examples
+print(infer([doc({"id": 1, "tags": ["a"]})]).to_dsl())
+#   record Root {
+#       "id": integer,
+#       "tags": string,
+#   }
+#   root Root
+
+# is a schema change backward-compatible? (operations are Schema methods)
+v1 = parse_schema('record R { "host": string }\nroot R')
+v2 = parse_schema('record R { "host": string, "port" [0,1]: integer }\nroot R')
+v1.compatible_with(v2)        # True -- adding an optional field is safe
+
+# schema-directed deserialization: upgrade leaves to match the schema
+s2 = parse_schema('record R { "d": date }\nroot R')
+read_json('{"d": "2024-01-01"}', schema=s2)   # [('d', datetime.date(2024, 1, 1))]
+```
+
+Run the full demo: `python3 examples/canonical_model.py`.
+
+## Installation
+
+Requires **Python 3.11+** (it uses the standard-library `tomllib`). The core and
+JSON support have no dependencies.
+
+```bash
+pip install omnist                      # core + JSON
+pip install omnist[all]                 # + pyyaml, tomli_w, defusedxml
+```
+
+Or from a checkout:
+
+```bash
+git clone https://github.com/tomlee/omnist.git
+cd omnist
+python3 -m venv .venv && source .venv/bin/activate
+pip install .                    # core + JSON
+pip install pyyaml tomli_w defusedxml   # YAML / writing TOML / hardened XML
+```
+
+## Documentation
+
+Full index: **[docs/](docs/README.md)**.
+
+- **[Quickstart](docs/quickstart.md)** — the shortest possible example: one
+  OML snippet, one schema, `validate()`, `infer()`.
+- **[User guide](docs/guide.md)** — the practical tour: documents,
+  [**OML**](docs/guide.md#oml--the-native-format) (the native format),
+  [**the schema DSL**](docs/guide.md#schemas--the-dsl), the Python builder,
+  validation, operations, other codecs, inference.
+- **[OML](docs/formats/oml.md)** — Omnist's own format, designed alongside the
+  model so every Document round-trips with zero adjustments, and how it maps
+  onto the Python Document.
+- **[The Schema model & DSL](docs/schema.md)** — Omnist's other central
+  feature: `record` definitions, cardinality, the Python builder, and the
+  comparison/inference operations.
+- **[API reference](docs/api.md)** — every public name, with signatures.
+- **[Schema-directed deserialization](docs/deserialization.md)** — what
+  changes (and what doesn't) about a Document's Python types when a schema
+  is, vs. isn't, passed to a reader.
+- **[A real-life example](docs/example.md)** — one order schema validated against
+  documents in JSON, YAML, TOML, and XML, plus a compatibility check.
+- **[Formats](docs/formats/overview.md)** — how each format maps to the model and
+  its caveats ([OML](docs/formats/oml.md) · [JSON](docs/formats/json.md) ·
+  [YAML](docs/formats/yaml.md) · [TOML](docs/formats/toml.md) ·
+  [XML](docs/formats/xml.md)).
+- **[Model spec](docs/design/model.md)** — the formal Document and Schema models,
+  self-contained and plain (no paper required).
+- **[Glossary](docs/glossary.md)** — one definition per term used across the
+  docs and code, grouped by concept area.
+- **[Testing](docs/testing.md)** — the test suite layout, coverage tooling and
+  target, the fuzzing approach, and what CI runs.
+- **[Repo layout](docs/layout.md)** — how the repo itself is organized:
+  `omnist/canonical/*.py` module responsibilities, the docs page map, and the
+  test file map.
+
+## Status
+
+Omnist is **alpha** (v0.2.0), built around a small, self-contained
+formalism; the public API may still change before a stable release.
+
+Feedback and bug reports welcome:
+<https://github.com/tomlee/omnist/issues>. See [SECURITY.md](SECURITY.md) for
+the trust model if you parse untrusted input.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+## Background
+
+The model is **inspired by** Lee & Cheung,
+[*"XML Schema Computations: Schema Compatibility Testing and Subschema
+Extraction"*](docs/paper/Lee-Cheung-2010-XML-Schema-Computations-CIKM.pdf)
+(CIKM 2010), simplified for the JSON family of formats. You don't need the
+paper to use Omnist — the [model spec](docs/design/model.md) is self-contained.

omnist-0.2.0/README.md

@@ -0,0 +1,162 @@
+# Omnist
+
+[![tests](https://github.com/tomlee/omnist/actions/workflows/test.yml/badge.svg)](https://github.com/tomlee/omnist/actions/workflows/test.yml)
+[![python](https://img.shields.io/badge/python-3.11%2B-blue)](#installation)
+[![license](https://img.shields.io/badge/license-Apache--2.0-lightgrey)](LICENSE)
+[![status](https://img.shields.io/badge/status-alpha-orange)](#status)
+
+**Omnist** ("omni-structure") is **one canonical data model for JSON, YAML,
+TOML, XML, and its own native OML (Omnist Markup Language)** — read any of
+them into a single tree, validate it against a schema, compare schema
+versions, and write it back out to any of the others.
+
+```python
+from omnist import parse_schema, doc
+
+s = parse_schema('''
+    record Member { "name": string, "role": string }
+    record Team   { "name": string, "members" [1,]: Member }
+    root Team
+''')
+
+s.validate(doc({"name": "Platform",
+                "members": [{"name": "Ann", "role": "dev"}]})).ok    # True
+```
+
+## Why Omnist
+
+If your service handles config or payloads in more than one format, you usually
+get a different library — and a different mental model — for each. Omnist
+gives you **one** model and **one** schema language over it, grounded in a small,
+self-contained formal model (inspired by Lee & Cheung, CIKM 2010):
+
+- A **Document** is a *tree* — an ordered list of labeled edges. Arrays are
+  just repeated labels, so the *same* Document represents JSON, YAML, TOML,
+  XML (including its interleaved repeated elements), and [OML](docs/formats/oml.md)
+  — Omnist's own format, the only one with zero loss in either direction.
+- A **Schema** is named `record` definitions (closed named fields, each with a
+  cardinality), where every field's type is always exactly one fixed scalar
+  (optionally nullable) or one `Ref` to a named record — referenced by name for
+  reuse and recursion. **Validate** a Document, **compare** two schemas for
+  backward-compatibility, or **infer** a schema from examples.
+- **Restrictive by default** — a schema guarantees structure; there are no
+  structureless escape hatches, and scalar types are never composed.
+
+The model is defined formally in
+[docs/design/model.md](docs/design/model.md); see
+[the quickstart](docs/quickstart.md) for the shortest possible example, or
+[the user guide](docs/guide.md) for the practical tour.
+
+## A 60-second tour
+
+```python
+from omnist import Doc, parse_schema, infer, doc, read_json
+
+# OML is omnist's own format -- see docs/formats/oml.md
+Doc.from_oml('id: 1\ntags: "a"\ntags: "b"\n').to_oml()
+
+# converting from other formats is just read one, write another
+Doc.from_json('{"id": 1, "tags": ["a", "b"]}').to_yaml()
+
+# describe a shape and check data against it; errors carry exact paths
+s = parse_schema('record R { "id": integer, "tags" [0,]: string }\nroot R')
+print(s.validate(doc({"id": "x", "tags": ["a"]})))
+#   invalid:
+#     at $.id: expected integer, got string ('x')
+
+# learn a schema from examples
+print(infer([doc({"id": 1, "tags": ["a"]})]).to_dsl())
+#   record Root {
+#       "id": integer,
+#       "tags": string,
+#   }
+#   root Root
+
+# is a schema change backward-compatible? (operations are Schema methods)
+v1 = parse_schema('record R { "host": string }\nroot R')
+v2 = parse_schema('record R { "host": string, "port" [0,1]: integer }\nroot R')
+v1.compatible_with(v2)        # True -- adding an optional field is safe
+
+# schema-directed deserialization: upgrade leaves to match the schema
+s2 = parse_schema('record R { "d": date }\nroot R')
+read_json('{"d": "2024-01-01"}', schema=s2)   # [('d', datetime.date(2024, 1, 1))]
+```
+
+Run the full demo: `python3 examples/canonical_model.py`.
+
+## Installation
+
+Requires **Python 3.11+** (it uses the standard-library `tomllib`). The core and
+JSON support have no dependencies.
+
+```bash
+pip install omnist                      # core + JSON
+pip install omnist[all]                 # + pyyaml, tomli_w, defusedxml
+```
+
+Or from a checkout:
+
+```bash
+git clone https://github.com/tomlee/omnist.git
+cd omnist
+python3 -m venv .venv && source .venv/bin/activate
+pip install .                    # core + JSON
+pip install pyyaml tomli_w defusedxml   # YAML / writing TOML / hardened XML
+```
+
+## Documentation
+
+Full index: **[docs/](docs/README.md)**.
+
+- **[Quickstart](docs/quickstart.md)** — the shortest possible example: one
+  OML snippet, one schema, `validate()`, `infer()`.
+- **[User guide](docs/guide.md)** — the practical tour: documents,
+  [**OML**](docs/guide.md#oml--the-native-format) (the native format),
+  [**the schema DSL**](docs/guide.md#schemas--the-dsl), the Python builder,
+  validation, operations, other codecs, inference.
+- **[OML](docs/formats/oml.md)** — Omnist's own format, designed alongside the
+  model so every Document round-trips with zero adjustments, and how it maps
+  onto the Python Document.
+- **[The Schema model & DSL](docs/schema.md)** — Omnist's other central
+  feature: `record` definitions, cardinality, the Python builder, and the
+  comparison/inference operations.
+- **[API reference](docs/api.md)** — every public name, with signatures.
+- **[Schema-directed deserialization](docs/deserialization.md)** — what
+  changes (and what doesn't) about a Document's Python types when a schema
+  is, vs. isn't, passed to a reader.
+- **[A real-life example](docs/example.md)** — one order schema validated against
+  documents in JSON, YAML, TOML, and XML, plus a compatibility check.
+- **[Formats](docs/formats/overview.md)** — how each format maps to the model and
+  its caveats ([OML](docs/formats/oml.md) · [JSON](docs/formats/json.md) ·
+  [YAML](docs/formats/yaml.md) · [TOML](docs/formats/toml.md) ·
+  [XML](docs/formats/xml.md)).
+- **[Model spec](docs/design/model.md)** — the formal Document and Schema models,
+  self-contained and plain (no paper required).
+- **[Glossary](docs/glossary.md)** — one definition per term used across the
+  docs and code, grouped by concept area.
+- **[Testing](docs/testing.md)** — the test suite layout, coverage tooling and
+  target, the fuzzing approach, and what CI runs.
+- **[Repo layout](docs/layout.md)** — how the repo itself is organized:
+  `omnist/canonical/*.py` module responsibilities, the docs page map, and the
+  test file map.
+
+## Status
+
+Omnist is **alpha** (v0.2.0), built around a small, self-contained
+formalism; the public API may still change before a stable release.
+
+Feedback and bug reports welcome:
+<https://github.com/tomlee/omnist/issues>. See [SECURITY.md](SECURITY.md) for
+the trust model if you parse untrusted input.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+## Background
+
+The model is **inspired by** Lee & Cheung,
+[*"XML Schema Computations: Schema Compatibility Testing and Subschema
+Extraction"*](docs/paper/Lee-Cheung-2010-XML-Schema-Computations-CIKM.pdf)
+(CIKM 2010), simplified for the JSON family of formats. You don't need the
+paper to use Omnist — the [model spec](docs/design/model.md) is self-contained.