bbfmodels 0.1.0__tar.gz

bbfmodels-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+          enable-cache: true
+      - name: Install
+        run: uv sync --frozen --group dev
+      - name: Cache the published documents
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/bbfmodels
+          key: bbf-documents-${{ hashFiles('src/bbfmodels/sources.py') }}
+      - name: Fetch the published documents
+        run: uv run bbfmodels fetch
+      - name: Format
+        run: uv run ruff format --check .
+      - name: Lint
+        run: uv run ruff check .
+      - name: Types
+        run: uv run mypy
+      - name: Test
+        run: uv run pytest -q
+      - name: Build
+        run: uv build

bbfmodels-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: docs
+
+# Build check only: deployment is handled by the docs host's git integration
+# watching main, so this repo carries no deploy configuration or secrets.
+on:
+  pull_request:
+    paths:
+      - "docs/**"
+      - "hooks/**"
+      - "CHANGELOG.md"
+      - "release-notes/**"
+      - "mkdocs.yml"
+      - "requirements.txt"
+      - ".github/workflows/docs.yml"
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "hooks/**"
+      - "CHANGELOG.md"
+      - "release-notes/**"
+      - "mkdocs.yml"
+      - "requirements.txt"
+      - ".github/workflows/docs.yml"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: requirements.txt
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Test the changelog hook
+        run: python -m unittest discover -s hooks
+
+      - name: Build site
+        run: mkdocs build --strict

bbfmodels-0.1.0/.github/workflows/pr-title.yml

@@ -0,0 +1,23 @@
+name: pr-title
+
+# PRs squash-merge, so the PR title becomes the commit subject that the
+# changelog and the version bump are computed from.
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+
+permissions: {}
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Title reads type(area): summary"
+        env:
+          TITLE: ${{ github.event.pull_request.title }}
+        run: |
+          pattern='^(feat|fix|perf|revert|docs|refactor|test|build|ci|chore|style)(\([a-z0-9][a-z0-9._/, +-]*\))?!?: [^ ].*$'
+          if ! printf '%s\n' "$TITLE" | grep -Eq "$pattern"; then
+            echo "::error::PR title must read type(area): summary, for example fix(api): reject cross-tenant lookups. Types: feat fix perf revert docs refactor test build ci chore style."
+            exit 1
+          fi

bbfmodels-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,63 @@
+name: publish
+
+# Runs on the vX.Y.Z tag that merging the Release PR creates. Builds the
+# wheel and sdist, attaches them to the GitHub release, and publishes to
+# PyPI through trusted publishing: PyPI trusts this repository's workflow
+# by name and environment, so no token is stored anywhere.
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: uv sync --frozen --group dev
+      - name: Cache the published documents
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/bbfmodels
+          key: bbf-documents-${{ hashFiles('src/bbfmodels/sources.py') }}
+      - name: Fetch the published documents
+        run: uv run bbfmodels fetch
+      - name: Test
+        run: uv run pytest -q
+      - name: The package version is the tag
+        run: |
+          version=$(uv run python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
+          test "$version" = "${GITHUB_REF_NAME#v}" || { echo "pyproject.toml says $version, tag is $GITHUB_REF_NAME"; exit 1; }
+      - name: Build
+        run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Attach to the GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release upload "$GITHUB_REF_NAME" dist/* --clobber
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/bbfmodels/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

bbfmodels-0.1.0/.github/workflows/release-please.yml

@@ -0,0 +1,42 @@
+name: release-please
+
+# Keeps one Release PR open against main with the next version and the
+# changelog entry built from the commits since the last tag. Merging that PR
+# creates the vX.Y.Z tag and the GitHub Release; workflows that publish or
+# deploy trigger on the tag. Tags pushed with the default GITHUB_TOKEN start
+# no workflows, which is why the step below mints a GitHub App token when the
+# repo has one configured.
+on:
+  push:
+    branches: [main]
+  workflow_dispatch: {} # refresh the Release PR after a commit override
+
+permissions:
+  contents: write
+  pull-requests: write
+  issues: write
+
+concurrency:
+  group: release-please
+  cancel-in-progress: false
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Mint release token
+        id: app
+        if: vars.RELEASE_APP_ID != ''
+        uses: actions/create-github-app-token@v2
+        with:
+          app-id: ${{ vars.RELEASE_APP_ID }}
+          private-key: ${{ secrets.RELEASE_APP_KEY }}
+
+      - name: Warn when no release token is configured
+        if: vars.RELEASE_APP_ID == ''
+        run: echo "::warning::RELEASE_APP_ID is not set. A tag created with the default token does not start the workflows that publish the release."
+
+      - name: Release Please
+        uses: googleapis/release-please-action@v5
+        with:
+          token: ${{ steps.app.outputs.token || github.token }}

bbfmodels-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Docs build output
+/site/
+
+# Local scratch
+.env
+.worktrees/
+
+# Editors and OS
+.idea/
+.vscode/
+*.swp
+.DS_Store

bbfmodels-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

bbfmodels-0.1.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

bbfmodels-0.1.0/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.0 (2026-11-02)
+
+
+### Added
+
+* **parser:** read a published document into the intermediate representation ([#1](https://github.com/ispx-limited/bbfmodels/issues/1)) ([462d045](https://github.com/ispx-limited/bbfmodels/commit/462d04530a7d3a7d62a3da440404f4afcadb2c4f))
+* **runtime:** resolve paths, hold a device's values and validate them against the schema ([#3](https://github.com/ispx-limited/bbfmodels/issues/3)) ([35146ad](https://github.com/ispx-limited/bbfmodels/commit/35146adb52757ac9a05836415f87815135c55b94))

bbfmodels-0.1.0/CLAUDE.md

@@ -0,0 +1,53 @@
+# bbfmodels
+
+Typed models and schema tooling for Broadband Forum data models, generated
+from the XML the Forum publishes. The README says what it is for; this file
+is for anyone, person or coding agent, working in the repository.
+
+## Layout
+
+- `context/` is the design memory: `context/decisions/` holds the
+  architecture decision records and `context/README.md` indexes them. Read
+  it before touching the parser, the IR or a generator, and add a record
+  when a change makes or reverses a significant decision.
+- `src/bbfmodels/` is the package. `cli.py` is the command line entry point.
+- `tests/` holds the pytest suite.
+- `docs/` is the documentation site (mkdocs), built strictly in CI. A page
+  exists when it has content; nothing is scaffolded empty.
+- `hooks/changelog.py` renders `CHANGELOG.md` and `release-notes/` as the
+  docs site's Changelog page. `CHANGELOG.md` is written by the release
+  automation and never edited by hand on `main`.
+
+## Commands
+
+- Set up: `scripts/bootstrap.sh`
+- Tests: `make test`
+- Format, lint, types: `make lint`
+- Docs: `make docs`
+
+## Rules
+
+- **The intermediate representation is the contract.** Everything downstream
+  of the parser reads the IR, never the XML. A new output language is an
+  emitter over the IR, not a second parser.
+- **Generated output is committed and never hand-edited.** Change the
+  generator or the source document, regenerate, and commit the result. CI
+  fails when committed output is stale.
+- **Names are the Forum's names.** Objects, parameters, commands and events
+  keep their PascalCase spelling verbatim. `{i}` stays in schema paths; data
+  paths carry instance numbers.
+- **No vendor or product knowledge in code.** Vendor extensions come from
+  the vendor's own TR-106 document and generate overlays. No lookup tables
+  of OUIs, model names or firmware versions.
+- **Everything optional, unknown paths kept.** A real device exposes a
+  subset of the model plus parameters the model does not know. A tree
+  built from device values keeps what it did not recognise and writes it
+  back unchanged.
+- **Python is written for Python.** ruff formats and lints, mypy runs
+  strict, pytest tests behaviour rather than implementation. New logic
+  ships with tests in the same change.
+- **Writing style**, in code comments, docs and commit messages: plain
+  words, short sentences, no em dashes, no emoji. Comments state what the
+  code cannot: a constraint, a reason, a reference to the specification.
+- Commits and PR titles read `type(area): imperative summary`. One change
+  per PR, squash merged.

bbfmodels-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Bug reports, corrections against the published models and code are welcome.
+Vendor extension documents in the TR-106 schema are especially welcome once
+the parser lands, because the tool is only as useful as the range of real
+device models it can read.
+
+## Building and testing
+
+```sh
+scripts/bootstrap.sh   # installs the pinned Python and dependencies with uv
+make test
+make lint              # format check, lint and type check, what CI runs
+```
+
+## Conventions
+
+- Commits and PR titles read `type(area): imperative summary`, for example
+  `fix(parser): a list facet with no item type is a list of strings`. CI
+  rejects any other title.
+- One change per PR. PRs are squash merged, so the title is the commit.
+- Generated files are never edited by hand. Change the generator or the
+  source document and regenerate; CI fails when committed output is stale.
+- Attribute and class names keep the Forum's PascalCase verbatim.
+- The tool carries no knowledge of any vendor or product. Vendor behaviour
+  comes from a vendor's own data model document, never from code.
+
+## Releases
+
+Merging the Release PR that release automation keeps open creates the
+version tag. The tag publishes the package to PyPI and attaches the wheel
+and sdist to the GitHub release. Nothing is tagged or uploaded by hand.

bbfmodels-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.

bbfmodels-0.1.0/Makefile

@@ -0,0 +1,26 @@
+.DEFAULT_GOAL := help
+.PHONY: help build test lint run docs clean
+
+help: ## List available targets
+	@awk 'BEGIN {FS = ":.*## "} /^[a-zA-Z_-]+:.*## / {printf "%-12s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+build: ## Build the wheel and sdist into dist/
+	uv build
+
+test: ## Run the test suite
+	uv run pytest -q
+
+lint: ## Format check, lint and type check, the same commands CI runs
+	uv run ruff format --check .
+	uv run ruff check .
+	uv run mypy
+
+run: ## Run the command line tool
+	uv run bbfmodels
+
+docs: ## Build the documentation site strictly
+	uv run --with-requirements requirements.txt --no-project python -m unittest discover -s hooks
+	uv run --with-requirements requirements.txt --no-project mkdocs build --strict
+
+clean: ## Remove build artifacts
+	rm -rf dist build site .venv .pytest_cache .mypy_cache .ruff_cache

bbfmodels-0.1.0/NOTICE

@@ -0,0 +1,2 @@
+bbfmodels
+Copyright 2026 ISPX LIMITED

bbfmodels-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.5
+Name: bbfmodels
+Version: 0.1.0
+Summary: Typed models and schema tooling for Broadband Forum data models (TR-181, TR-098, TR-104 and more), generated from the published XML
+Project-URL: Homepage, https://github.com/ispx-limited/bbfmodels
+Project-URL: Documentation, https://docs.bbfmodels.ispx.co/
+Project-URL: Changelog, https://docs.bbfmodels.ispx.co/changelog/
+Author: ISPX LIMITED
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: broadband-forum,cwmp,data-model,tr-069,tr-098,tr-181,tr-369,usp
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Telecommunications Industry
+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 :: System :: Networking
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.14
+Description-Content-Type: text/markdown
+
+# bbfmodels
+
+Typed models and schema tooling for Broadband Forum data models (TR-181,
+TR-098, TR-104 and the rest), generated from the XML the Forum publishes.
+
+The Forum defines what a broadband gateway exposes to its management system
+as XML in the TR-106 schema: thousands of objects and parameters, their types,
+ranges, enumerations, writability and multi-instance tables. Everyone who
+builds against those models, an ACS, a USP controller, a device simulator, an
+integration script, re-derives the same facts from the same XML and hand-types
+the same parameter paths as strings. bbfmodels does it once:
+
+- A parser that reads the published XML into a normalised intermediate
+  representation, published as JSON with its own schema.
+- A Python runtime that works from that representation: resolve a path,
+  validate a value against the model's constraints, convert between the flat
+  path and value lists that CWMP and USP carry on the wire and a typed tree.
+- Generated typed bindings: pydantic models for Python first, JSON Schema and
+  TypeScript from the same representation, Go when there is a consumer.
+
+Names stay as the Forum wrote them. `Device.WiFi.SSID.{i}.SSID` is a table of
+`SSID` entries indexed by instance number, and the attribute is `SSID`, not
+`ssid`.
+
+## Status
+
+Pre-release. The parser, the intermediate representation and the runtime
+are in place: `bbfmodels fetch` downloads the Forum's published documents,
+`bbfmodels ir` turns one into JSON, and the `Schema` and `Tree` classes
+resolve paths, hold a device's values and validate them. Generated Python
+models come next. Until the first release there is no package on PyPI.
+
+The design decisions behind the code are in `context/decisions/`, indexed in
+`context/README.md`. Read them before changing the parser or the IR.
+
+## Development
+
+Prerequisites: git and [uv](https://docs.astral.sh/uv/). The pinned Python is
+installed by uv.
+
+```sh
+scripts/bootstrap.sh
+make test
+make lint
+```
+
+`make help` lists the rest. Documentation is built from `docs/` with
+`make docs` and published at https://docs.bbfmodels.ispx.co/.
+
+## Licence
+
+Apache-2.0, copyright ISPX LIMITED. The Broadband Forum publishes its data
+models under the BSD 3-clause licence; output derived from them carries the
+Forum's notice.