softschema 0.1.1__tar.gz

softschema-0.1.1/.gitignore

@@ -0,0 +1,225 @@
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Local scratch space
+tmp/
+trash/
+attic/
+*.bak
+*.orig
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

softschema-0.1.1/AGENTS.md

@@ -0,0 +1,77 @@
+# Agent Instructions
+
+This repo teaches and implements the soft schema pattern.
+
+Start here:
+
+- [Softschema Guide](docs/softschema-guide.md): standalone concept and adoption guide
+  for humans and agents.
+- [Softschema Spec](docs/softschema-spec.md): exact language-neutral artifact format.
+- [Movie page example](examples/movie_page/README.md): complete Python-backed example.
+
+For implementer reference (only when changing the Python package itself):
+
+- [Python Package Design](docs/softschema-python-design.md): module layout, CLI surface,
+  validation layers, and ADR-style decisions.
+  Skip when only authoring or validating artifacts.
+
+Key rules:
+
+- Treat YAML/frontmatter as the authoritative structured data.
+- Do not parse Markdown body prose or tables for consumed values.
+- Use `softschema.contract`, not `schema`, in authored artifact metadata.
+- Contract IDs name artifact payload contracts, not a specific Python class.
+- Keep examples public and practical; do not introduce private business context,
+  internal project names, or proprietary domains.
+- Use `uv` for Python workflows.
+
+Common commands:
+
+```bash
+uv sync --all-extras
+uv run python devtools/lint.py --check
+uv run pytest
+uv build
+uv run softschema docs --list
+uv run softschema docs --list --json
+uv run softschema skill --brief
+```
+
+When adding a schema, start by identifying the values downstream consumers actually
+need. Promote those values into YAML, validate them at the boundary, and leave the rest
+as readable Markdown unless it is truly consumed as data.
+
+Documentation rules:
+
+- Follow `common-doc-guidelines.md` (github.com/jlevy/practical-prose): clear structure,
+  concise language, present-state descriptions, and enough context for a low-context
+  reader.
+- Keep the README as a short subset of `docs/softschema-guide.md`.
+- Put exact artifact-format rules in `docs/softschema-spec.md`.
+- Keep examples as copyable source files under `examples/`; the CLI may print them, but
+  should not scaffold or mutate projects in the first release.
+- Include the standard documentation footer in repo docs.
+  Do not add it to authored softschema example artifacts.
+
+<!-- This document follows common-doc-guidelines.md.
+See github.com/jlevy/practical-prose and review guidelines before editing.
+-->
+
+<!-- BEGIN TBD INTEGRATION format=f04 surface=agents-md -->
+## tbd
+
+This repository uses **tbd** for git-native issue tracking (beads), spec-driven
+planning, and on-demand engineering guidelines.
+As the agent, you operate tbd on the user’s behalf — translate their requests into tbd
+actions rather than telling them to run commands.
+
+- Run `tbd prime` to load current project state and the full tbd workflow.
+- Run `tbd skill` for the complete reusable tbd skill instructions.
+- Run `tbd shortcut --list` and `tbd guidelines --list` for on-demand resources.
+- Track all work as beads: `tbd create`, `tbd ready`, `tbd close`, and `tbd sync`.
+
+<!-- END TBD INTEGRATION -->
+
+<!-- This document follows common-doc-guidelines.md.
+See github.com/jlevy/practical-prose and review guidelines before editing.
+-->

softschema-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joshua Levy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

softschema-0.1.1/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: softschema
+Version: 0.1.1
+Summary: Soft schema conventions and validation tools for Markdown/YAML artifacts
+Project-URL: Homepage, https://github.com/jlevy/softschema
+Project-URL: Repository, https://github.com/jlevy/softschema
+Project-URL: Issues, https://github.com/jlevy/softschema/issues
+Author: Joshua Levy
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+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: <4.0,>=3.11
+Requires-Dist: frontmatter-format>=0.3.0
+Requires-Dist: jsonschema>=4.20
+Requires-Dist: pydantic>=2
+Requires-Dist: pyyaml
+Description-Content-Type: text/markdown
+
+# softschema
+
+Soft schemas are a practice for adding structure gradually to artifacts that mix human
+context and machine-readable values.
+
+They are useful when a document is valuable as context for humans and agents and also
+needs a few values that downstream code or agents can read reliably.
+Keeping prose and structured values in one artifact is more context-efficient and more
+flexible than splitting them: a reader (human or agent) has only one place to look, and
+each value can stay as loose prose until a downstream consumer needs it formal.
+
+The practice is language-neutral.
+This repo ships a spec and an implementation in Python.
+
+It’s generally easiest to do this with Markdown and YAML frontmatter.
+The YAML carries the structured values.
+The Markdown body stays readable for humans and agents and offers additional context.
+
+**Soft schemas** name the general practice; **softschema** names both this repository’s
+Markdown-and-YAML spec and the matching `softschema` CLI that implements it.
+The CLI is a Python package usable as a command-line tool or library for formatting,
+compilation, validation, and other common workflows.
+
+## Core Idea
+
+A *hard* schema imposes structure up front: define a rigid contract, then reject
+anything that doesn’t fit.
+That suits data that is already uniform, but it is a poor fit for documents a human or
+agent writes, where most of the content is prose and only a few values need to be
+machine-readable.
+
+A soft schema adds structure gradually instead.
+Structure runs along a spectrum, and each value moves along it only when it earns the
+move:
+
+```text
+prose
+  -> expected sections and vocabulary
+  -> YAML/frontmatter values for consumed fields
+  -> schema validation at boundaries
+  -> pure data or deterministic code when the shape is stable
+```
+
+Promote a value into YAML when a tool reads it, validate it at the boundary when
+correctness matters, and tighten enforcement over time.
+Each promotion buys efficiency for some downstream consumer, so structure and efficiency
+grow together, value by value.
+Everything else stays readable Markdown.
+The structured values live in the YAML payload, the boundary a tool reads, while the
+prose body stays unconstrained.
+Structure has real costs in authoring effort and rigidity, and adding it before a
+consumer needs it costs more than leaving it loose: a contract with consumers is harder
+to loosen than prose is to tighten.
+So add structure where it pays for itself.
+This fits the file artifacts that pass between steps of an agent process, where each
+artifact mixes the context a step produces with the few values the next step consumes.
+It works especially well in pipelines built for coding agents, which can call the
+`softschema` CLI to test and validate the code, docs, and data they produce, alongside
+the linters, tests, and type checkers they already run.
+
+## Artifact Shape
+
+The default shape is Markdown with YAML frontmatter.
+Use `softschema.contract` to name the contract for the enclosed payload:
+
+```markdown
+---
+softschema:
+  contract: example.movies:MoviePage/v1
+  status: enforced
+movie:
+  title: Spirited Away
+  release_year: 2001
+  runtime_minutes: 125
+  mpaa_rating: PG
+  directors:
+    - Hayao Miyazaki
+  genres:
+    - Animation
+    - Adventure
+    - Family
+  synopsis: >
+    Ten-year-old Chihiro and her parents stumble into a mysterious abandoned town
+    that turns out to be a spirit world...
+  cast:
+    - actor: Rumi Hiiragi
+      character: Chihiro / Sen
+    - actor: Miyu Irino
+      character: Haku
+  ratings:
+    rotten_tomatoes:
+      critics_percent: 96
+      audience_percent: 96
+      critic_review_count: 225
+    imdb:
+      score: 8.6
+      total_votes: 850000
+---
+# Spirited Away (2001)
+
+Hayao Miyazaki’s animated fantasy follows ten-year-old Chihiro into a spirit world, where
+she works in a bathhouse for the gods to free her parents from a witch’s curse. It won the
+2003 Academy Award for Best Animated Feature.
+
+Critics and audiences both score it 96% on Rotten Tomatoes; IMDb users rate it 8.6/10.
+```
+
+The YAML payload is authoritative.
+The Markdown body overlaps with it but need not match it field for field: here the prose
+adds the film’s Oscar win and leaves out the cast and genres, while a consumer reads
+only the YAML.
+
+The example illustrates the structural variety a softschema artifact can carry:
+constrained integers (`release_year`, `runtime_minutes`), an enum (`mpaa_rating`
+restricted to `G`, `PG`, `PG-13`, `R`, `NC-17`, `NR`), lists of strings (`directors`,
+`genres`), a list of structured records (`cast`), and nested objects (`ratings`). The
+full artifact, model, and generated JSON Schema live under
+[examples/movie_page/](examples/movie_page/README.md).
+
+## Contract IDs
+
+Recommended style:
+
+```text
+namespace:UpperCamelCaseName/version
+```
+
+Examples:
+
+- `example.movies:MoviePage/v1`
+- `example.docs:IncidentReview/v1`
+- `com.acme.docs:IncidentReview/1.0`
+
+The ID names an artifact payload contract, not a required class or import path.
+
+## Try the Python Package
+
+Install dependencies:
+
+```bash
+uv sync --all-extras
+```
+
+Validate the example:
+
+```bash
+uv run softschema validate examples/movie_page/spirited-away.md \
+  --model examples.movie_page.model:MoviePage \
+  --schema examples/movie_page/movie-page.schema.yaml
+```
+
+`validate` reads `softschema.contract`, `softschema.status`, and the single top-level
+envelope key from the YAML by default.
+Use `--contract`, `--status`, or `--envelope` only to override or disambiguate.
+
+Read the bundled docs from the CLI:
+
+```bash
+uv run softschema docs --list
+uv run softschema docs --list --json
+uv run softschema docs guide
+uv run softschema docs example-artifact
+uv run softschema skill --brief
+```
+
+The examples are plain files under `examples/`. The CLI can print them so an agent or
+human can copy from them, but it does not scaffold or mutate another project.
+
+Compile the example schema sidecar:
+
+```bash
+uv run softschema compile examples.movie_page.model:MoviePage \
+  --contract example.movies:MoviePage/v1 \
+  --out examples/movie_page/movie-page.schema.yaml
+```
+
+## Repository Layout
+
+```text
+docs/                  guide, spec, Python package design, and workflow docs
+examples/movie_page/   complete example with model, host integration, artifact, schema
+packages/python/       Python implementation and tests
+packages/typescript/   future TypeScript/Zod notes only
+skills/softschema/     agent-facing usage guidance
+```
+
+The root `pyproject.toml` builds the Python package from
+`packages/python/src/softschema`. This keeps the first release simple while leaving room
+for a future TypeScript package.
+
+## Docs
+
+- [Softschema Guide](docs/softschema-guide.md)
+- [Softschema Spec](docs/softschema-spec.md)
+- [Python Package Design](docs/softschema-python-design.md)
+- [Installing uv and Python](docs/installation.md)
+- [Development](docs/development.md)
+- [Publishing](docs/publishing.md)
+- [Movie Page Example](examples/movie_page/README.md)
+
+<!-- This document follows common-doc-guidelines.md.
+See github.com/jlevy/practical-prose and review guidelines before editing.
+-->