ansiburr 0.0.1__tar.gz

ansiburr-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  quality:
+    name: lint, type-check, test
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.5.x"
+
+      - name: Pin Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Sync dependencies
+        run: uv sync --python ${{ matrix.python-version }}
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+      - name: Mypy
+        run: uv run mypy src/ansiburr
+
+      - name: Pytest
+        # Tests that talk to ansible-runner need ansible-playbook on PATH;
+        # ansible-core (a runtime dep) provides it through uv sync. Skip
+        # the network-touching unreachable test in CI (RFC 5737 traffic
+        # behavior varies by network policy).
+        run: uv run pytest tests/ -v --deselect tests/test_failures.py::test_unreachable_host_sets_last_unreachable
+
+  build:
+    name: build wheel + sdist
+    runs-on: ubuntu-latest
+    needs: quality
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.5.x"
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+          retention-days: 7

ansiburr-0.0.1/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+*.egg
+.eggs/
+
+# Build artifacts
+build/
+dist/
+.venv/
+venv/
+
+# Tooling caches
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+
+# Demo SSH keys — regenerated per-clone by examples/service_remediation/setup.sh
+examples/service_remediation/.demo_key
+examples/service_remediation/.demo_key.pub
+
+# Local demo state co-located with each example
+examples/coffee_order_ansible/.queue/
+examples/.hero-state/
+
+# Burr local tracker output (project-relative if anyone re-roots HOME)
+.burr/
+
+# Editor / OS
+.vscode/
+.idea/
+.DS_Store

ansiburr-0.0.1/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Changelog
+
+All notable changes to ansiburr are documented in this file. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project adheres
+to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1] - 2026-05-21
+
+Initial alpha release.
+
+### Added
+
+- `module_action` decorator wrapping `ansible-runner` as a Burr `@action`.
+  Supports `reads`, `writes`, `register`, `host`, `connection`, `become`,
+  `check_mode`, `diff`.
+- `host()` factory plus `Host` dataclass for connection profiles. Captures
+  Ansible hostvars and `become` once; exposes shorthand decorators
+  (`.module`, `.service`, `.systemd`, `.shell`, `.command`, `.copy`,
+  `.template`, `.file`, `.find`, `.slurp`, `.uri`).
+- `Host.gather_facts()` runs `ansible.builtin.setup` and flattens facts
+  into top-level State keys. `Host.initial_facts()` seeds placeholder
+  values so transitions can read fact keys before the gather has executed.
+- Ambient sentinel state keys written by every `@module_action`:
+  `_last_action`, `_last_failed`, `_last_changed`, `_last_unreachable`,
+  `_last_msg`. `initial_sentinels()` provides placeholder seeds.
+- `snapshot_sentinels(write="failure_reason")` pure-Python action that
+  preserves the current diagnostic into a durable state key, surviving
+  any recovery actions that overwrite the sentinels.
+- `wait_until(name, check, condition_expr, max_attempts, interval_s,
+  on_success, on_timeout)` polling sub-graph builder. Returns a
+  `WaitGraph` to merge into an `ApplicationBuilder`. Each poll attempt
+  is a discrete Burr step.
+- `from_playbook(path)` forward converter. Parses a YAML playbook and
+  returns a runnable `burr.core.Application`. Supports single play with
+  flat task list, `when:`, `register:`, `failed_when:`, `become:`,
+  `gather_facts:`, and play-level `vars:`. Raises
+  `UnsupportedPlaybookConstruct` for blocks, loops, handlers, includes,
+  roles, and multi-play structures.
+- ControlPersist and pipelining enabled by default for SSH connection
+  reuse across modules targeting the same host.
+- Eleven self-contained example FSMs in `examples/` spanning
+  `ansible.builtin`, `community.crypto`, `community.docker`,
+  `community.general`, and `ansible.posix`.
+- VHS-recorded GIFs for two demos (`fact_driven_inspect`,
+  `plan_then_apply`) plus the tape sources.
+- pytest suite with smoke, failure-mode, and converter coverage.
+- GitHub Actions CI for Python 3.11, 3.12, 3.13 on Linux.
+
+### Known gaps
+
+- Single-host only. Multi-host inventories and parallel fan-out are not
+  yet supported; one Burr `Application` per host is the current pattern.
+- No reverse converter. `from_playbook` covers the playbook-to-FSM
+  direction; FSM-to-playbook emission is on the roadmap.
+- The Burr dependency is pinned to a tight range. Burr is incubating at
+  Apache, and an API change in a release ansiburr does not yet support
+  will break installs at version-resolution time rather than at runtime.
+
+[0.0.1]: https://github.com/msradam/ansiburr/releases/tag/v0.0.1
+[Unreleased]: https://github.com/msradam/ansiburr/compare/v0.0.1...HEAD

ansiburr-0.0.1/LICENSE

@@ -0,0 +1,203 @@
+
+                                 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.
+Copyright 2026 Adam Munawar Rahman

ansiburr-0.0.1/NOTICE

@@ -0,0 +1,41 @@
+ansiburr
+Copyright 2026 Adam Munawar Rahman
+
+This product includes software developed under the Apache License, Version 2.0.
+
+It depends on the following third-party software:
+
+  * ansible-runner (Apache License 2.0)
+      https://github.com/ansible/ansible-runner
+      Used as the supported Python API for invoking Ansible modules; directly
+      imported by ansiburr.
+
+  * Burr (Apache License 2.0)
+      https://github.com/apache/burr
+      Used as the state-machine substrate that ansiburr's @module_action
+      decorator produces actions for; directly imported by ansiburr.
+
+  * PyYAML (MIT License)
+      https://pyyaml.org/
+      Used to write Ansible playbook + inventory artifacts to the temporary
+      private_data_dir consumed by ansible-runner.
+
+ansiburr also requires ansible-core at runtime, which is licensed under the
+GNU General Public License, version 3 or later (GPL-3.0-or-later). ansiburr
+does not import ansible-core's Python modules directly. ansible-runner
+(Apache-2.0) invokes ansible-playbook as a separate subprocess; the
+relationship to ansible-core is therefore tool-use rather than derivative
+work. Users who redistribute an installed ansiburr environment should be
+aware that the ansible-core component carries GPL-3.0+ obligations.
+
+  * ansible-core (GPL-3.0-or-later)
+      https://github.com/ansible/ansible
+      Invoked as a subprocess by ansible-runner; not imported by ansiburr.
+
+The Ansible module collections that user FSMs actually call (ansible.builtin,
+ansible.posix, community.crypto, community.docker, community.general, etc.)
+have their own licenses, typically GPL-3.0-or-later for ansible.builtin
+content and a mix of Apache-2.0 / GPL-3.0-or-later for community collections.
+Refer to each collection's individual repository for the authoritative terms.
+
+This notice is informational. It does not constitute legal advice.

ansiburr-0.0.1/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: ansiburr
+Version: 0.0.1
+Summary: Run Ansible modules as Burr state-machine actions in Python.
+Project-URL: Homepage, https://github.com/msradam/ansiburr
+Project-URL: Source, https://github.com/msradam/ansiburr
+Project-URL: Issues, https://github.com/msradam/ansiburr/issues
+Author-email: Adam Munawar Rahman <msrahmanadam@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Ansible
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+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 :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: <3.14,>=3.11
+Requires-Dist: ansible-core<3,>=2.16
+Requires-Dist: ansible-runner<3,>=2.4
+Requires-Dist: burr[tracking]<0.41,>=0.40.2
+Requires-Dist: pyyaml>=6
+Description-Content-Type: text/markdown
+
+# ansiburr
+
+> *Pardon me, are you Ansi-Burr, Sir?*
+
+Run Ansible modules as Burr state-machine actions in Python.
+
+A single decorator wraps an Ansible module call as a Burr `@action`. The module runs through `ansible-runner` against the target host. Its result projects into Burr's `State`, and the action's `_last_failed`, `_last_changed`, and `_last_msg` flags become available to downstream transitions. The output is a standard Burr `Application` that runs, persists, traces, and serves like any other Burr graph.
+
+![ansiburr stepping through a deploy-and-wait FSM with a polling sub-graph](vhs/hero.gif)
+
+## What you can build
+
+- Self-healing service workflows that observe, decide, and remediate one Ansible module at a time, with every step visible in Burr's tracker.
+- SRE agents where an LLM picks one label from a fixed allow-list of remediation actions and the FSM (not the model) enforces termination and retry policy.
+- Cross-platform automation that gathers facts on the target up front and dispatches to the right modules based on the OS family, init system, or package manager.
+- Plan-then-apply pipelines using Ansible's `--check` and `--diff` with a deterministic review gate before any change runs.
+- Polling sub-graphs (port readiness, service health, file existence) where every poll attempt is a discrete step in the trace.
+
+## Install
+
+```sh
+uv add ansiburr
+# or
+pip install ansiburr
+```
+
+`ansible-core` is pulled in transitively as a runtime requirement. Install additional collections via `ansible-galaxy`:
+
+```sh
+ansible-galaxy collection install community.general community.crypto community.docker ansible.posix
+```
+
+## Quickstart
+
+An FSM that gathers facts from a remote host and dispatches to a distro-appropriate package inspection command:
+
+```python
+from burr.core import ApplicationBuilder, action, expr
+from burr.tracking import LocalTrackingClient
+from ansiburr import host, initial_sentinels
+
+target = host(
+    "target",
+    ansible_host="server.example.com",
+    ansible_user="ops",
+    ansible_ssh_private_key_file="~/.ssh/id_ed25519",
+    become=True,
+)
+
+
+@target.shell(register="pkg_inspect")
+def inspect_apt(state):
+    return {"cmd": "dpkg -l | wc -l"}
+
+
+@target.shell(register="pkg_inspect")
+def inspect_dnf(state):
+    return {"cmd": "rpm -qa | wc -l"}
+
+
+@action(
+    reads=["ansible_distribution", "ansible_pkg_mgr", "pkg_inspect"],
+    writes=["report"],
+)
+def summarize(state):
+    count = (state["pkg_inspect"].get("stdout") or "0").strip()
+    return state.update(
+        report=f"{state['ansible_distribution']} ({state['ansible_pkg_mgr']}): {count} pkgs"
+    )
+
+
+app = (
+    ApplicationBuilder()
+    .with_actions(
+        gather=target.gather_facts(),
+        inspect_apt=inspect_apt,
+        inspect_dnf=inspect_dnf,
+        summarize=summarize,
+    )
+    .with_transitions(
+        ("gather", "inspect_apt", expr("ansible_pkg_mgr == 'apt'")),
+        ("gather", "inspect_dnf", expr("ansible_pkg_mgr == 'dnf'")),
+        ("inspect_apt", "summarize"),
+        ("inspect_dnf", "summarize"),
+    )
+    .with_tracker(LocalTrackingClient(project="quickstart"))
+    .with_state(**initial_sentinels(), **target.initial_facts(), pkg_inspect={}, report="")
+    .with_entrypoint("gather")
+    .build()
+)
+
+_, _, final = app.run(halt_after=["summarize"])
+print(final["report"])
+```
+
+The same FSM works against Debian, RHEL, Fedora, Arch, or any other distro Ansible supports. The branch is taken by the gathered fact, not by hard-coded logic.
+
+## Demo corpus
+
+`examples/` contains eleven self-contained FSMs. Most run against a local Docker container set up by `examples/service_remediation/setup.sh`.
+
+| Demo | What it shows | Collections used |
+|---|---|---|
+| `localhost_disk_check` | Linear chain, pure-Python branching on shell output | `ansible.builtin` |
+| `service_remediation` | Retry loop with state counter, ssh plus become, escalate after N attempts | `ansible.builtin` |
+| `cert_rotation` | Linear-with-skip, idempotent multi-step rotation, pure-Python date math | `community.crypto`, `ansible.builtin` |
+| `config_drift` | Handler equivalent via `_last_changed`, validate-before-apply (`nginx -t`), rollback with reload-after-restore | `ansible.builtin` |
+| `user_provisioning` | Iteration via state counter, mid-loop failure preserves partial state | `ansible.builtin`, `ansible.posix` |
+| `sidecar_lifecycle` | Container lifecycle FSM running on the controller against local Docker | `community.docker` |
+| `log_triage` | Ansible I/O wrapping a Python parser and a Granite-classifier with a deterministic validator gate | `ansible.builtin` |
+| `mast_sre_agent` | MAST-aligned deep multi-module remediation (12 Ansible modules plus 7 Python actions) | `ansible.builtin`, `ansible.posix`, `community.general` |
+| `coffee_order_ansible` | Burr's `coffee_order` topology with every action body swapped for an Ansible module operating on a filesystem queue | `ansible.builtin` |
+| `fact_driven_inspect` | `gather_facts()` state expansion; transitions branch on `ansible_pkg_mgr` | `ansible.builtin` |
+| `plan_then_apply` | check+diff plan, deterministic review gate, `wait_until` polling sub-graph, apply with verify | `ansible.builtin` |
+
+Each example runs in seconds. Run an individual demo with `uv run python examples/<name>/fsm.py`.
+
+The full library API and the Ansible-playbook-idiom mapping live in [REFERENCE.md](./REFERENCE.md).
+
+## Dependencies and licensing
+
+ansiburr is licensed under the Apache License 2.0. See `LICENSE` for the full text.
+
+ansiburr imports only Apache-2.0 and MIT licensed code (`ansible-runner`, `burr`, `pyyaml`). At runtime it requires `ansible-core`, which is licensed under GPL-3.0-or-later and is invoked as a separate subprocess by `ansible-runner` rather than imported directly. Anyone redistributing an installed ansiburr environment should be aware that the bundled `ansible-core` component carries GPL-3.0+ obligations, and that individual Ansible collections in the user's `ansible_collections` path may have their own licenses.
+
+The `NOTICE` file contains the canonical attribution and license summary.
+
+This README is engineering documentation, not legal advice.
+
+## Development
+
+```sh
+git clone https://github.com/msradam/ansiburr
+cd ansiburr
+uv sync
+uv run pytest
+uv run ruff check .
+uv run mypy src/ansiburr
+```
+
+Most examples require a small Docker container. `examples/service_remediation/setup.sh` builds the image and generates a per-clone SSH key; `examples/service_remediation/start.sh` runs the container.
+
+ansiburr was developed with significant AI assistance (Anthropic's Claude). All changes were reviewed and committed by the project owner.
+
+## Acknowledgements
+
+- The Burr team (Apache Software Foundation) for the FSM substrate.
+- The Ansible community for the module ecosystem.
+- IBM Research and UC Berkeley for the MAST failure-mode taxonomy ([blog](https://huggingface.co/blog/ibm-research/itbenchandmast), [arXiv:2503.13657](https://arxiv.org/abs/2503.13657)).
+
+## License
+
+Apache License 2.0. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE).