crc-event-schemas 0.1.5

CloudEvents type bindings for console.redhat.com

console.redhat.com CloudEvents for Python

This repo contains Python bindings of the JSON schema definitions for events generated by console.redhat.com

Getting started

crc-event-schemas is available on PyPi. You can install using pip.

$ pip install crc-event-schemas

Layout

• api: Defines a submodule with the current version of console.redhat.com CloudEvents.
• examples: Contains examples on how to use this library.
• event_schemas: Python bindings for console.redhat.com cloud events.

Generating code

The generate.js script generates the Python code.

This script is executed on any push to our main branch, ensuring it never goes out of sync.

Releasing a new version

The release process works with release-please-action. You can head to their documentation to learn more about it, but in a nutshell:

• Uses Conventional Commits
• Creates a PR when there is something to be released (patch, minor or major). Once that PR is merged, a new release occurs.

The release is published to PyPi.

Docs

Docs are automatically generated and hosted on GitHub pages: https://redhatinsights.github.io/event-schemas-python/.