Align with Go SDK (#11)

* DRAFT: Align with Go SDK

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Fix subject content mapping. Add schema validation to tests.

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Clean up old files (to be reintroduced later)

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Add readme

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Fix Github workflow syntax

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Add Makefile

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Fix dev install:

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Fix humps dependency

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Fix humps dependency

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Add submodule init to Github workflow

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

* Fix codecov.yml EOF

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>

---------

Signed-off-by: Erik Sternerson <[email protected]>
Signed-off-by: erkist <[email protected]>
Co-authored-by: elmsdata <[email protected]>

Author: erkist

.github/workflows/main.yml

@@ -7,6 +7,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+        with:
+          submodules: recursive
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
@@ -25,12 +27,14 @@ jobs:
         python: ['3.7', '3.8', '3.9', '3.x']
     steps:
       - uses: actions/checkout@v3
+        with:
+          submodules: recursive
       - name: Setup Python ${{ matrix.python }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
-        run: make package-install
+        run: make dev-install
       - name: Run tests
         run: make test
       - name: Run tests and collect coverage

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "src/tests/spec"]
+	path = src/tests/spec
+	url = https://github.com/cdevents/spec

Makefile

@@ -1,6 +1,6 @@
 include header.mk
 
-PACKAGES = core
+PACKAGES = src
 export ABS_ROOT_PATH=$(shell pwd)
 
 .PHONY: packages $(PACKAGES)
@@ -13,6 +13,7 @@ $(PACKAGES):
 # the sets of directories to do various things in
 INITPACKAGES = $(PACKAGES:%=init-%)
 INSTALLPACKAGES = $(PACKAGES:%=package-install-%)
+DEVINSTALLPACKAGES = $(PACKAGES:%=dev-install-%)
 CLEANPACKAGES = $(PACKAGES:%=clean-%)
 TESTPACKAGES = $(PACKAGES:%=test-%)
 LINTPACKAGES = $(PACKAGES:%=lint-%)
@@ -26,6 +27,10 @@ package-install: $(INSTALLPACKAGES) ## Installs all packages without dev depende
 $(INSTALLPACKAGES):
 	$(MAKE) -C $(@:package-install-%=%) package-install
 
+dev-install: $(DEVINSTALLPACKAGES) ## Installs all packages without dev dependencies
+$(DEVINSTALLPACKAGES):
+	$(MAKE) -C $(@:dev-install-%=%) dev-install
+
 test: $(TESTPACKAGES) ## Run tests on all packages
 $(TESTPACKAGES):
 	$(MAKE) -C $(@:test-%=%) test
@@ -62,6 +67,7 @@ docker-shell: ## Opens a bash
 .PHONY: packages $(PACKAGES)
 .PHONY: packages $(INITPACKAGES)
 .PHONY: packages $(INSTALLPACKAGES)
+.PHONY: packages $(DEVINSTALLPACKAGES)
 .PHONY: packages $(TESTPACKAGES)
 .PHONY: packages $(CLEANPACKAGES)
 .PHONY: packages $(BUMPVERSIONPACKAGES)

README.md

@@ -2,4 +2,68 @@
 
 Python SDK for CDEvents
 
-update ...
+The SDK can be used to create CDEvents in CloudEvents form, for use with the
+  [CloudEvents Python SDK](https://github.com/cloudevents/sdk-python).
+
+## Disclaimer 🚧
+
+This SDK is work in work in progress, it will be maintained in sync with the
+specification and it now covers all events from the specification.
+
+## Get started
+
+Clone the repo and install the Python SDK as a package:
+
+```golang
+cd src && pip install .
+```
+
+And import the module in your code
+
+```golang
+import cdevents
+```
+
+## Create your first CDEvent
+
+To create a CDEvent, for instance a [*pipelineRun queued*](https://cdevents.dev/docs/core/#pipelinerun-queued) one:
+
+```python
+import cdevents
+
+event = cdevents.new_pipelinerun_queued_event(
+    context_id="my-context-id",
+    context_source="my/first/cdevent/program",
+    context_timestamp=datetime.datetime.now(),
+    subject_id="myPipelineRun1",
+    custom_data={"hello_message": "hi!"},
+    custom_data_content_type="application/json",
+    pipeline_name="myPipeline",
+    url="https://example.com/myPipeline",
+)
+```
+
+## Send your first CDEvent as CloudEvent
+
+To send a CDEvent as CloudEvent:
+
+```python
+import cdevents
+
+# Create a CloudEvent from the CDEvent
+cloudevent = cdevents.to_cloudevent(event)
+
+# Creates the HTTP request representation of the CloudEvent in structured content mode
+headers, body = to_structured(event)
+
+# POST
+requests.post("<some-url>", data=body, headers=headers)
+
+```
+
+See the [CloudEvents](https://github.com/cloudevents/sdk-python) docs as well.
+
+## References
+
+- [CDEvents](https://cdevents.dev)
+- [CDFoundation SIG Events Vocabulary Draft](https://github.com/cdfoundation/sig-events/tree/main/vocabulary-draft)