idea139-opendeployment-quil.../README.md

26 lines
1.2 KiB
Markdown

# OpenDeployment Quilt — Reference Python Implementation
This repository contains a focused reference implementation for the OpenDeployment Quilt idea: a federated, consent-based observability fabric for CI/CD across organizations and clouds.
Goals in this repo
- Provide canonical data primitives (LocalPlan, SharedSignals, PlanDelta, AuditLog) as pydantic models
- Provide a small registry and conformance checks for adapters
- Ship two adapter skeletons (GitHub Actions and Jenkins) to demonstrate the adapter contract
- Provide a lightweight async coordinator that shows how aggregated signals can be reduced into PlanDelta suggestions
- Tests, packaging metadata, and developer docs so agents and humans can extend the project
Quickstart
1. Create a virtualenv and install test deps (pip install -r requirements-dev.txt) or simply run tests with any pytest-enabled environment.
2. Run tests: `bash test.sh`
Project layout
- src/idea139_opendeployment_quilt_federated: package source
- tests: pytest tests
Important files
- `pyproject.toml` - packaging metadata (name = idea139-opendeployment-quilt-federated)
- `AGENTS.md` - developer rules and architecture notes
- `test.sh` - runs pytest and `python3 -m build`
License: Apache-2.0