Signed-off-by: Denis Makogon <lildee1991@gmail.com> |
||
---|---|---|
.github | ||
cloudevents | ||
docs | ||
etc/docs_conf | ||
.gitignore | ||
LICENSE | ||
Makefile | ||
README.md | ||
circle.yml | ||
release.sh | ||
release_doc.md | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
README.md
Python SDK for CloudEvents
NOTE: This SDK is still considered work in progress, things might (and will) break with every update.
Package cloudevents provides primitives to work with CloudEvents specification: https://github.com/cloudevents/spec.
Parsing upstream Event from HTTP Request:
from cloudevents.sdk.event import v02
from cloudevents.sdk import marshaller
data = "<this is where your CloudEvent comes from>"
m = marshaller.NewDefaultHTTPMarshaller(v02.Event)
event = m.FromRequest(
{"Content-Type": "application/cloudevents+json"},
data,
lambda x: x.read()
)
Creating a minimal CloudEvent in version 0.1:
from cloudevents.sdk.event import v01
event = (
v01.Event().
SetContentType("application/json").
SetData('{"name":"john"}').
SetEventID("my-id").
SetSource("from-galaxy-far-far-away").
SetEventTime("tomorrow").
SetEventType("cloudevent.greet.you")
)
Creating HTTP request from CloudEvent:
from cloudevents.sdk import converters
from cloudevents.sdk import marshaller
from cloudevents.sdk.converters import structured
from cloudevents.sdk.event import v01
event = (
v01.Event().
SetContentType("application/json").
SetData('{"name":"john"}').
SetEventID("my-id").
SetSource("from-galaxy-far-far-away").
SetEventTime("tomorrow").
SetEventType("cloudevent.greet.you")
)
m = marshaller.NewHTTPMarshaller(
[
structured.NewJSONHTTPCloudEventConverter(type(event))
]
)
headers, body = m.ToRequest(event, converters.TypeStructured, lambda x: x)
The goal of this package is to provide support for all released versions of CloudEvents, ideally while maintaining the same API. It will use semantic versioning with following rules:
- MAJOR version increments when backwards incompatible changes is introduced.
- MINOR version increments when backwards compatible feature is introduced INCLUDING support for new CloudEvents version.
- PATCH version increments when a backwards compatible bug fix is introduced.