oatschema-adapters 0.1.0__tar.gz

oatschema_adapters-0.1.0/.gitattributes

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2026 The OATS Authors
+# SPDX-License-Identifier: Apache-2.0
+
+* text=auto eol=lf
+
+tests/data/expected/** -text

oatschema_adapters-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# SPDX-FileCopyrightText: 2026 The OATS Authors
+# SPDX-License-Identifier: Apache-2.0
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Claude
+CLAUDE.md
+CLAUDE.local.md
+.claude/
+
+# Antigravity
+.antigravity/
+.antigravity.md

oatschema_adapters-0.1.0/AUTHORS

@@ -0,0 +1,4 @@
+The OATS Authors are the copyright holders of OATS. This file lists them.
+Individuals and organisations may add themselves when they contribute.
+
+Dorsal Hub LTD

oatschema_adapters-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.0 (2026-10-31)
+
+First release.
+
+- Exporters for `audio-transcription` (SRT, WebVTT, Markdown, plain text and TSV) and `document-extraction` (HTML, hOCR, Markdown, plain text and TSV) records, with parsers for every format except document HTML and Markdown.
+- Records are validated with `oatschema`, against the newest bundled schema version or the one passed as `schema_version`.
+- `register_adapter` adds adapters for other schemas and formats to the same registry.
+- Carries over the OATS adapters of `dorsalhub-adapters` 0.4.3, with bare schema names (no `open/` prefix), keyword-only options, and fixes to TSV, WebVTT, Markdown and hOCR output and parsing.

oatschema_adapters-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+The schemas themselves are maintained in [oatschema/oats](https://github.com/oatschema/oats), and bundled for Python by [oatschema](https://github.com/oatschema/oatschema-py). This repository holds the adapters that convert records to and from other formats. Bug reports and pull requests are welcome.
+
+## Development
+
+```
+uv sync
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+uv run mypy src tests scripts
+```
+
+`scripts/check.sh` runs all of these, with the tests on every supported Python version.
+
+## Tests
+
+- Every rule an adapter follows has tests on every path it applies to: export and parse, validated and unvalidated, and Python values and command-line strings.
+- `tests/test_golden.py` compares every export, and the parse of each export, with the output recorded from `dorsalhub-adapters` 0.4.3, the package this one replaced, in `tests/data/expected/`. A case may differ only if it's listed in `CHANGED` with its reason. To add cases, edit `tests/golden_cases.py` and record them again in a throwaway environment:
+
+  ```
+  uv run --isolated --no-project --with dorsalhub-adapters==0.4.3 python scripts/record_043_outputs.py
+  ```
+
+- Fixtures in `tests/data/` are named `<schema>-<description>.json`, and invalid ones start with `invalid-`. Each adapter needs at least one fixture valid at every schema version `oatschema` bundles; `tests/test_versions.py` checks this.
+- Coverage must stay at or above 80% overall, and 90% on each pull request's changed lines.
+
+## Versions
+
+The package version follows [semantic versioning](https://semver.org), independently of the schema versions. Until 1.0, a minor release may change the API and a patch release won't. Every release has a CHANGELOG entry saying what changed, and whether anything breaks.
+
+## Licensing and sign-off
+
+- The adapters are licensed under Apache-2.0, and contributions are accepted under the same licence. There is no CLA.
+- Contributors keep the copyright in their contributions. Copyright is held by The OATS Authors, and you may add yourself or your employer to `AUTHORS`.
+- Every commit needs a [Developer Certificate of Origin](https://developercertificate.org/) sign-off: commit with `git commit -s`.
+- Every new source file (`.py`, `.toml`, `.yml`, `.sh`) starts with this header, which the tests check:
+
+  ```
+  # SPDX-FileCopyrightText: 2026 The OATS Authors
+  # SPDX-License-Identifier: Apache-2.0
+  ```
+
+  Keep the year as it is in new files; it is the year the project started, not the current year.

oatschema_adapters-0.1.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.

oatschema_adapters-0.1.0/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.5
+Name: oatschema-adapters
+Version: 0.1.0
+Summary: Export OATS (Open Annotation Task Schemas) records to standard formats, and parse them back.
+Project-URL: Homepage, https://oatschema.org
+Project-URL: Repository, https://github.com/oatschema/oatschema-adapters-py
+Project-URL: Changelog, https://github.com/oatschema/oatschema-adapters-py/blob/main/CHANGELOG.md
+Author-email: OATS maintainers <maintainers@oatschema.org>
+License-Expression: Apache-2.0
+License-File: AUTHORS
+License-File: LICENSE
+Keywords: annotation,hocr,json-schema,oats,ocr,srt,transcription,webvtt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: oatschema[validate]<0.9,>=0.8.0.2
+Requires-Dist: srt>=3.5.3
+Requires-Dist: webvtt-py>=0.5.1
+Description-Content-Type: text/markdown
+
+# oatschema-adapters
+
+[![PyPI](https://img.shields.io/pypi/v/oatschema-adapters.svg)](https://pypi.org/project/oatschema-adapters/)
+[![Python versions](https://img.shields.io/pypi/pyversions/oatschema-adapters.svg)](https://pypi.org/project/oatschema-adapters/)
+[![CI](https://github.com/oatschema/oatschema-adapters-py/actions/workflows/ci.yml/badge.svg)](https://github.com/oatschema/oatschema-adapters-py/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/oatschema/oatschema-adapters-py/graph/badge.svg)](https://codecov.io/gh/oatschema/oatschema-adapters-py)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/oatschema/oatschema-adapters-py/blob/main/LICENSE)
+
+Export [OATS](https://oatschema.org) (Open Annotation Task Schemas) records to standard formats, and parse those formats back into records.
+
+- **`audio-transcription`** records become SRT or WebVTT subtitles, Markdown, plain text or a TSV table, and each of those parses back.
+- **`document-extraction`** records become HTML, hOCR, Markdown, plain text or a TSV table. hOCR, plain text and TSV parse back.
+- **Validated.** Records are validated with [oatschema](https://pypi.org/project/oatschema/) before export and after parsing, against the schema version you name.
+- **Safe with untrusted records.** Every value is escaped in HTML and hOCR, whether or not the record was validated, and no TSV cell runs as a spreadsheet formula.
+- **Typed.** Ships `py.typed`.
+
+## Quick start
+
+```
+pip install oatschema-adapters
+```
+
+```python
+from oatschema_adapters import get_adapter
+
+record = {
+    "language": "eng",
+    "segments": [
+        {"text": "Welcome back.", "start_time": 0.5, "end_time": 2.25, "speaker": {"id": "s1", "name": "Maria"}},
+        {"text": "Thank you.", "start_time": 2.5, "end_time": 3.0, "speaker": {"id": "s2", "name": "Jean"}},
+    ],
+}
+
+vtt = get_adapter("audio-transcription", "vtt")
+captions = vtt.export(record, include_speakers=True)
+# WEBVTT
+#
+# 00:00:00.500 --> 00:00:02.250
+# <v Maria>Welcome back.
+# ...
+
+parsed = vtt.parse(captions)  # an audio-transcription record, validated
+```
+
+Requires Python 3.11 or later.
+
+## Formats
+
+| Schema | Format | Aliases | Extension | Parses |
+| :--- | :--- | :--- | :--- | :--- |
+| `audio-transcription` | `srt` | | `srt` | yes |
+| | `vtt` | `webvtt` | `vtt` | yes |
+| | `md` | `markdown` | `md` | yes |
+| | `txt` | | `txt` | yes |
+| | `tsv` | | `tsv` | yes |
+| `document-extraction` | `html` | | `html` | no |
+| | `hocr` | `hocr.html` | `hocr.html` | yes |
+| | `md` | `markdown` | `md` | no |
+| | `txt` | | `txt` | yes |
+| | `tsv` | | `tsv` | yes |
+
+`list_schemas()` and `list_formats(schema)` list them at run time, and `format_aliases(schema)` maps each alias to its format.
+
+```python
+from oatschema_adapters import get_adapter, list_formats
+
+list_formats("document-extraction")
+# [('hocr', 'hOCR (.html) - ...'), ('html', 'Semantic HTML (.html) - ...'), ...]
+
+adapter = get_adapter("document-extraction", "markdown")
+adapter.format_name  # 'md'
+adapter.extension  # 'md'
+adapter.can_parse  # False
+```
+
+An `Adapter` has `export(record, **options)` and `parse(content, **options)`, and `export_file` and `parse_file` for file objects. `export` takes a dict, or a JSON object as `str` or `bytes`.
+
+## Options
+
+Every exporter and parser takes `validate` (default `True`) and `schema_version` (default `None`, the newest version `oatschema` bundles). Parsers also take `producer`, the parsed record's `producer`.
+
+| Schema | Format | Export options |
+| :--- | :--- | :--- |
+| `audio-transcription` | `srt`, `vtt`, `tsv` | `include_speakers=False` |
+| | `md` | `include_timestamps=True`, `include_milliseconds=False`, `include_speakers=False`, `include_frontmatter=True`, `low_confidence_threshold=0.8` |
+| `document-extraction` | `html` | `layout="col"` (`"col"`, `"grid"` or `"wireframe"`), `style="default"` (`"default"`, `"dark"` or `"none"`), `style_path=None`, `footer=None`, `fragment=False`, `gap_x=-1.0`, `gap_y=-1.0`, and the layout options below |
+| | `md` | `include_frontmatter=True`, `low_confidence_threshold=0.8`, and the layout options below |
+| | `txt` | the layout options below |
+
+The layout options decide how blocks are joined into lines and paragraphs: `strict=False`, `line_tolerance=5.0`, `paragraph_margin=20.0`, `column_jump=-10.0` and `scale=None`. The document `tsv` parser takes `unit="px"`, and the `hocr` parser takes `target_class="ocr_line"`.
+
+Options are keyword arguments. A value given as a string, as from a command line, is converted to the option's type: `"false"`, `"no"`, `"off"` and `"0"` are false, and `"0.5"` is a number. A value that can't be converted, or an option the adapter doesn't have, raises an error naming it:
+
+```python
+adapter.export(record, include_speakers="maybe")
+# ValueError: to_vtt() option 'include_speakers' must be true or false, not 'maybe'
+adapter.export(record, include_speaker=True)
+# TypeError: to_vtt() got unknown option(s) 'include_speaker'; options: validate, schema_version, include_speakers
+```
+
+You can also call the functions directly, from `oatschema_adapters.audio` and `oatschema_adapters.document`:
+
+```python
+from oatschema_adapters.document import to_html
+
+fragment = to_html(document_record, layout="wireframe", fragment=True)
+```
+
+## Validation
+
+Records are validated before they're exported, and parsed records before they're returned. A record that doesn't conform raises `oatschema.ValidationError`, which says where and why without quoting the record's values:
+
+```python
+import oatschema
+
+try:
+    get_adapter("audio-transcription", "srt").export({"segments": [{"text": "hi", "start_time": -1, "end_time": 1}]})
+except oatschema.ValidationError as error:
+    print(error)  # audio-transcription 0.8.0 at /segments/0/start_time: … is less than the minimum of 0
+    print(error.keyword)  # minimum
+```
+
+Pass `schema_version="0.6.0"` to validate against an older version, such as the one a stored record was written for; any version from 0.4.0 that `oatschema` bundles works. An unbundled version raises `LookupError`. Pass `validate=False` to skip validation.
+
+Output is escaped whether or not the record was validated, so `validate=False` is safe for untrusted records: every value is escaped in HTML and hOCR, a `style` value is only ever a theme name, never a file to read, and a stylesheet from `style_path` can't close its `<style>` element.
+
+## TSV and spreadsheets
+
+A TSV cell that starts with `=`, `+`, `-`, `@`, a tab or a carriage return gets a leading `'`, unless the whole cell is a number, so Excel, LibreOffice Calc and Google Sheets show it as text instead of running it as a formula. A cell that already starts with `'` followed by one of those characters gets another `'`. The TSV parsers remove exactly one, so exporting and parsing gives back the original text. The one exception is the audio exporter, which, as before, replaces tabs in a segment's text with spaces and trims surrounding whitespace.
+
+## Adding adapters
+
+`register_adapter` adds an adapter to the same registry, for another schema or another format of an OATS schema. Give the functions as `"module:function"` strings, so they're imported only when used:
+
+```python
+from oatschema_adapters import get_adapter, register_adapter
+
+register_adapter(
+    "example/citation",
+    "bibtex",
+    description="BibTeX (.bib) - A bibliographic reference format.",
+    extension="bib",
+    export="my_package.bibtex:to_bibtex",
+    aliases=["bib"],
+)
+
+get_adapter("example/citation", "bib").export(record)
+```
+
+The export function takes the record first and its options as keyword arguments; a parse function takes the content first. Registering a format that already exists raises `ValueError` unless you pass `replace=True`. Validating records of schemas other than OATS is up to your functions.
+
+## Versions
+
+`oatschema-adapters` uses [semantic versioning](https://semver.org), independently of the OATS schema versions. Until 1.0, a minor release (0.2.0) may change the API, and a patch release (0.1.1) won't. Pin with `oatschema-adapters>=0.1,<0.2`. It depends on `oatschema[validate]>=0.8.0.2,<0.9`.
+
+See the [CHANGELOG](https://github.com/oatschema/oatschema-adapters-py/blob/main/CHANGELOG.md) for what changed in each release.
+
+## License
+
+Apache-2.0. Copyright The OATS Authors; see [AUTHORS](https://github.com/oatschema/oatschema-adapters-py/blob/main/AUTHORS).