https://github.com/open-component-model/odg-core
Core API of ODG (github.com/open-component-model/open-delivery-gear)
https://github.com/open-component-model/odg-core
compliance delivery ocm odg open-delivery-gear python toolkit
Last synced: 19 days ago
JSON representation
Core API of ODG (github.com/open-component-model/open-delivery-gear)
- Host: GitHub
- URL: https://github.com/open-component-model/odg-core
- Owner: open-component-model
- License: apache-2.0
- Created: 2024-04-03T18:35:53.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2026-06-09T10:18:19.000Z (21 days ago)
- Last Synced: 2026-06-09T10:24:32.783Z (21 days ago)
- Topics: compliance, delivery, ocm, odg, open-delivery-gear, python, toolkit
- Language: Python
- Homepage: https://open-component-model.github.io/odg-core/
- Size: 17.7 MB
- Stars: 8
- Watchers: 2
- Forks: 14
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Open Delivery Gear Core
[](https://api.reuse.software/info/github.com/open-component-model/odg-core)
This repository is used for developing the `Delivery-Service` + Extensions, which are part of the
Open Delivery Gear. It exposes a RESTful API useful for delivery- and compliance-related tasks
for OCM-based software deliveries.
Both Delivery-Service and (optional) Extensions are intended to be deployed into a common Kubernetes
cluster.
# Local Development
Delivery-Service and Extensions require a Python runtime environment (see `setup.py` for details) to
run. Typically, the Python3 version from greatest released version of
[Alpine](https://endoflife.date/alpine) Linux is used/tested (see `Dockerfile`). Greater or smaller
versions _may_ work, but are typically untested.
For Delivery-Service, use `app.py` as entry point. Check online-help (`app.py --help`) for further
instructions. Note that most features of Delivery-Service are optional (features are disabled by
default unless explicitly enabled through additional configuration).
Please refer to [this guide](https://open-component-model.github.io/odg-core/local_setup.html)
for a step-by-step description on how to setup the Delivery-Service (and an extension if desired).
## Getting Started using Kind
If you wish to deploy the Open Delivery Gear (Delivery-Service, Delivery-Dashboard, Delivery-DB,
Extensions) in a local Kubernetes cluster using Kind, please refer to
[this guide](https://github.com/open-component-model/odg-core/blob/master/local-setup/local-setup.md).
# REST-API-Documentation
Delivery-Service exposes generated documentation through the following route: `/api/v1/doc`
> [!NOTE]
> For a full (-> still WIP) documentation, please visit https://open-component-model.github.io/odg-core.
