utterplan 0.1.1__tar.gz

utterplan-0.1.1/.codecrate.toml

@@ -0,0 +1,25 @@
+[codecrate]
+output = "context_utterplan.md"
+keep_docstrings = true
+dedupe = true
+metadata = false
+respect_gitignore = true
+exclude = ["*/.venv/*", "context_utterplan.*"]
+gitignore_allow = ["utterplan/_version.py"]
+include = [
+  "**/*.py",
+  "**/*.toml",
+  "**/*.md",
+  "**/*.json",
+  "**/*.txt",
+  "**/*.csv",
+  "**/*.tsv",
+  "**/*.yaml",
+  "**/*.yml",
+  "**/*.ssmd",
+  "LICENSE",
+]
+split_max_chars = 0
+layout = "full"
+profile = "portable-agent"
+emit_standalone_unpacker = true

utterplan-0.1.1/.github/workflows/codecov.yml

@@ -0,0 +1,29 @@
+name: Codecov
+
+on:
+  push:
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Run tests with coverage
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install coverage pytest pytest-cov
+          python -m pip install -e ".[dev]"
+          python -m pytest -m "not reference" --cov=utterplan --cov-report=xml --junitxml=junit.xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

utterplan-0.1.1/.github/workflows/pre-commit.yml

@@ -0,0 +1,31 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install Python tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install "ruff==0.16.0"
+
+      - name: Install Node tools
+        run: |
+          npm install -g prettier@2.7.1 @prettier/plugin-xml@2.2.0 eslint
+
+      - uses: pre-commit/action@v3.0.1

utterplan-0.1.1/.github/workflows/python-publish.yml

@@ -0,0 +1,90 @@
+# Build and publish a Python package when a GitHub Release is published.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out release
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install build tooling
+        run: python -m pip install --upgrade pip build twine
+      - name: Build package
+        run: |
+          rm -rf dist
+          python -m build
+      - name: Check built distributions
+        run: python -m twine check dist/*
+      - name: Validate release artifacts
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: |
+          python - <<'PY'
+          import os
+          import re
+          import zipfile
+          from email import policy
+          from email.parser import Parser
+          from pathlib import Path
+
+          from packaging.requirements import Requirement
+          from packaging.version import Version
+
+          def has_minimum(requirements, name, minimum):
+              minimum_version = Version(minimum)
+              return any(
+                  requirement.name == name
+                  and any(
+                      spec.operator in (">=", ">", "==")
+                      and Version(spec.version) >= minimum_version
+                      for spec in requirement.specifier
+                  )
+                  for requirement in requirements
+              )
+
+          tag_version = os.environ["RELEASE_TAG"].removeprefix("v")
+          artifacts = list(Path("dist").iterdir())
+          wheels = [path for path in artifacts if path.suffix == ".whl"]
+          sdists = [path for path in artifacts if path.name.endswith(".tar.gz")]
+          assert len(wheels) == 1, wheels
+          assert len(sdists) == 1, sdists
+          wheel_version = re.match(r"utterplan-([^-]+)-", wheels[0].name).group(1)
+          sdist_version = re.match(r"utterplan-([^-]+)\.tar\.gz$", sdists[0].name).group(1)
+          assert wheel_version == tag_version, (wheel_version, tag_version)
+          assert sdist_version == tag_version, (sdist_version, tag_version)
+
+          with zipfile.ZipFile(wheels[0]) as archive:
+              metadata_name = next(name for name in archive.namelist() if name.endswith("METADATA"))
+              metadata = Parser(policy=policy.default).parsestr(
+                  archive.read(metadata_name).decode("utf-8")
+              )
+              requirements = [
+                  Requirement(value) for value in metadata.get_all("Requires-Dist", [])
+              ]
+              assert has_minimum(requirements, "phrasplit", "0.3.9")
+              assert has_minimum(requirements, "ssmd", "0.8.7")
+              assert has_minimum(requirements, "spokenform", "0.4.3")
+              assert any(name.endswith("utterplan/py.typed") for name in archive.namelist())
+              assert any(name.endswith("utterplan/utterplan.schema.json") for name in archive.namelist())
+          PY
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.14.1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          attestations: false

utterplan-0.1.1/.github/workflows/tests.yml

@@ -0,0 +1,94 @@
+name: Run tests
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+          python -m compileall -q utterplan tests
+      - name: Type-check package
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13'
+        run: python -m mypy utterplan
+      - name: Lint package
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13'
+        run: python -m ruff check .
+      - name: Run tests
+        run: python -m pytest -q -m "not reference"
+
+  lower-bounds:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install lower-bound dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pytest jsonschema
+          python -m pip install \
+            "phrasplit==0.3.9" \
+            "ssmd==0.8.7" \
+            "spokenform==0.4.3" \
+            "typing_extensions>=4.0"
+          python -m pip install --no-deps -e .
+      - name: Run lower-bound tests
+        run: python -m pytest -q -m "not reference"
+
+  package-smoke:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build wheel
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build --wheel --outdir "$RUNNER_TEMP/wheels"
+      - name: Verify wheel contents
+        run: |
+          python - <<'PY'
+          import os
+          from pathlib import Path
+          from zipfile import ZipFile
+
+          wheel = next((Path(os.environ["RUNNER_TEMP"]) / "wheels").glob("*.whl"))
+          names = set(ZipFile(wheel).namelist())
+          assert "utterplan/py.typed" in names
+          assert "utterplan/utterplan.schema.json" in names
+          PY
+      - name: Install wheel in clean environment
+        run: |
+          python -m venv "$RUNNER_TEMP/utterplan-wheel-venv"
+          "$RUNNER_TEMP/utterplan-wheel-venv/bin/python" -m pip install \
+            "$RUNNER_TEMP"/wheels/utterplan-*.whl
+      - name: Run installed smoke checks
+        run: |
+          "$RUNNER_TEMP/utterplan-wheel-venv/bin/python" -c \
+            "import importlib.metadata as m; import utterplan; assert m.version('utterplan') == utterplan.__version__"
+          "$RUNNER_TEMP/utterplan-wheel-venv/bin/utterplan" --version
+          "$RUNNER_TEMP/utterplan-wheel-venv/bin/utterplan" compile \
+            "Doctor Smith bought 5 kg." --lang en-us --json > "$RUNNER_TEMP/utterplan.json"
+          "$RUNNER_TEMP/utterplan-wheel-venv/bin/utterplan" validate "$RUNNER_TEMP/utterplan.json"
+          "$RUNNER_TEMP/utterplan-wheel-venv/bin/utterplan" inspect \
+            "$RUNNER_TEMP/utterplan.json" --segment 0

utterplan-0.1.1/.gitignore

@@ -0,0 +1,221 @@
+# 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
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+context_utterplan*.*
+
+utterplan/_version.py

utterplan-0.1.1/.ledger/ledger.toml

@@ -0,0 +1,24 @@
+schema_version = 3
+
+[project]
+uuid = "c4a0577e-8faa-417b-b0da-259b21947378"
+name = "utterplan"
+
+[ledgers.taskledger.mounts.data]
+storage = "external"
+root = "../ledger"
+
+[ledgers.taskledger.mounts.runtime]
+storage = "user-data"
+
+[ledgers.taskledger.mounts.logs]
+storage = "user-data"
+
+[ledgers.taskledger.mounts.indexes]
+storage = "cache"
+
+[ledgers.releaseledger.mounts.data]
+storage = "project"
+
+[ledgers.releaseledger.mounts.indexes]
+storage = "cache"

utterplan-0.1.1/.ledger/releaseledger/.ledger-project.toml

@@ -0,0 +1,6 @@
+schema_version = 1
+layout_version = 3
+project_uuid = "c4a0577e-8faa-417b-b0da-259b21947378"
+tool = "releaseledger"
+mount = "config"
+storage = "project"

utterplan-0.1.1/.ledger/releaseledger/config.toml

@@ -0,0 +1,56 @@
+config_version = 2
+# Branch-scoped release state. This block is safe to commit.
+ledger_ref = "main"
+ledger_parent_ref = ""
+ledger_branch_guard = "off"
+# Cross-ledger identity. Local record IDs stay unchanged.
+
+[ledger]
+code = "rl"
+# Release defaults.
+
+[release]
+default_changelog = "CHANGELOG.md"
+default_status = "planned"
+allow_dirty_worktree = true
+# Changelog build defaults.
+
+[changelog]
+output = "docs/changelog.md"
+header = ""
+body = """## {% if release.date %}[{{ release.version }}] - {{ release.date }}{% else %}[{{ release.version }}] - Unreleased{% endif %}
+
+{% for group in groups %}
+### {{ group.title }}
+{% for entry in group.entries %}
+- {% if entry.breaking %}**BREAKING:** {% endif %}{{ entry.summary }}
+{% endfor %}
+
+{% endfor %}
+"""
+footer = "<!-- generated by releaseledger -->"
+trim = true
+render_always = false
+postprocessors = []
+standard = ""
+group_mode = "extended"
+link_references = false
+repository_url = ""
+tag_prefix = "v"
+compare_url_template = ""
+release_url_template = ""
+preamble = ""
+semver = false
+unreleased = true
+# Git-first release evidence.
+
+[git]
+enabled = true
+default_base = "previous_release_tag"
+default_head = "HEAD"
+previous_tag_patterns = ["v{version}", "{version}"]
+include_merges = "nontrivial"
+require_clean_worktree = false
+max_commits = 500
+max_diff_chars_per_commit = 12000
+candidate_status = "draft"

utterplan-0.1.1/.ledger/releaseledger/data/.ledger-project.toml

@@ -0,0 +1,6 @@
+schema_version = 1
+layout_version = 3
+project_uuid = "c4a0577e-8faa-417b-b0da-259b21947378"
+tool = "releaseledger"
+mount = "data"
+storage = "project"

utterplan-0.1.1/.ledger/releaseledger/data/ledgers/main/events/events.jsonl

@@ -0,0 +1,8 @@
+{"data":{"status":"planned"},"event":"release.created","event_id":"event-0001","record_revisions":{"release:0.1.0":1},"release_version":"0.1.0","schema_version":2}
+{"data":{"kind":"added","status":"accepted"},"entry_id":"entry-0001","event":"entry.added","event_id":"event-0002","record_revisions":{"entry:0.1.0/entry-0001":1,"release:0.1.0":2},"release_version":"0.1.0","schema_version":2}
+{"data":{"kind":"changed","status":"accepted"},"entry_id":"entry-0002","event":"entry.added","event_id":"event-0003","record_revisions":{"entry:0.1.0/entry-0002":1,"release:0.1.0":3},"release_version":"0.1.0","schema_version":2}
+{"data":{"kind":"docs","status":"accepted"},"entry_id":"entry-0003","event":"entry.added","event_id":"event-0004","record_revisions":{"entry:0.1.0/entry-0003":1,"release:0.1.0":4},"release_version":"0.1.0","schema_version":2}
+{"data":{"kind":"quality","status":"accepted"},"entry_id":"entry-0004","event":"entry.added","event_id":"event-0005","record_revisions":{"entry:0.1.0/entry-0004":1,"release:0.1.0":5},"release_version":"0.1.0","schema_version":2}
+{"data":{"fields":["note","title"]},"event":"release.updated","event_id":"event-0006","record_revisions":{"release:0.1.0":6},"release_version":"0.1.0","schema_version":2}
+{"data":{"added_source_refs":[],"fields":["paths"],"reason":"Update release paths after package rename.","removed_source_refs":[],"source_refs_mode":"unchanged"},"entry_id":"entry-0001","event":"entry.updated","event_id":"event-0007","record_revisions":{"entry:0.1.0/entry-0001":2},"release_version":"0.1.0","schema_version":2}
+{"data":{"added_source_refs":[],"fields":["paths"],"reason":"Update release paths after package rename.","removed_source_refs":[],"source_refs_mode":"unchanged"},"entry_id":"entry-0002","event":"entry.updated","event_id":"event-0008","record_revisions":{"entry:0.1.0/entry-0002":2},"release_version":"0.1.0","schema_version":2}

utterplan-0.1.1/.ledger/releaseledger/data/ledgers/main/releases/0.1.0/entries/entry-0001.md

@@ -0,0 +1,25 @@
+---
+schema_version: 2
+object_type: release_entry
+versioning:
+  schema_version: 1
+  revision: 2
+entry_id: entry-0001
+release_version: 0.1.0
+kind: added
+summary: Added interactive text, stdin, SSMD, and file compilation workflows
+status: accepted
+audience: null
+scopes: []
+source_refs: []
+paths:
+  - utterplan/cli.py
+  - tests/test_cli.py
+issues: []
+prs: []
+sources: []
+contributors: []
+breaking: false
+internal: false
+order: 1
+---

utterplan-0.1.1/.ledger/releaseledger/data/ledgers/main/releases/0.1.0/entries/entry-0002.md

@@ -0,0 +1,25 @@
+---
+schema_version: 2
+object_type: release_entry
+versioning:
+  schema_version: 1
+  revision: 2
+entry_id: entry-0002
+release_version: 0.1.0
+kind: changed
+summary: Aligned migration dependency floors and packaged typing metadata
+status: accepted
+audience: null
+scopes: []
+source_refs: []
+paths:
+  - pyproject.toml
+  - utterplan/py.typed
+issues: []
+prs: []
+sources: []
+contributors: []
+breaking: false
+internal: false
+order: 2
+---

utterplan-0.1.1/.ledger/releaseledger/data/ledgers/main/releases/0.1.0/entries/entry-0003.md

@@ -0,0 +1,28 @@
+---
+schema_version: 2
+object_type: release_entry
+versioning:
+  schema_version: 1
+  revision: 1
+entry_id: entry-0003
+release_version: 0.1.0
+kind: docs
+summary:
+  Added buildable MyST user and developer documentation for the public planning
+  boundary
+status: accepted
+audience: null
+scopes: []
+source_refs: []
+paths:
+  - docs/index.md
+  - docs/getting-started.md
+  - docs/consumer-guide.md
+issues: []
+prs: []
+sources: []
+contributors: []
+breaking: false
+internal: false
+order: 3
+---