cloudevents
diff --git a/‎.github/workflows/pypi-release.yml‎
Lines changed: 28 additions & 0 deletions b/‎.github/workflows/pypi-release.yml‎
Lines changed: 28 additions & 0 deletions
diff --git a/‎.isort.cfg‎
Lines changed: 4 additions & 0 deletions b/‎.isort.cfg‎
Lines changed: 4 additions & 0 deletions
diff --git a/‎.pre-commit-config.yaml‎
Lines changed: 10 additions & 0 deletions b/‎.pre-commit-config.yaml‎
Lines changed: 10 additions & 0 deletions
diff --git a/‎CHANGELOG.md‎
Lines changed: 11 additions & 0 deletions b/‎CHANGELOG.md‎
Lines changed: 11 additions & 0 deletions
diff --git a/‎README.md‎
Lines changed: 70 additions & 126 deletions b/‎README.md‎
Lines changed: 70 additions & 126 deletions
diff --git a/‎RELEASING.md‎
Lines changed: 25 additions & 0 deletions b/‎RELEASING.md‎
Lines changed: 25 additions & 0 deletions
diff --git a/‎cloudevents/__init__.py‎
Lines changed: 1 addition & 0 deletions b/‎cloudevents/__init__.py‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎cloudevents/http/__init__.py‎
Lines changed: 23 additions & 0 deletions b/‎cloudevents/http/__init__.py‎
Lines changed: 23 additions & 0 deletions
@@ -0,0 +1,28 @@
+name: PyPI-Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.x"
+      - name: Install build dependencies
+        run: pip install -U setuptools wheel build
+      - name: Build
+        run: python -m build .
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.pypi_password }}
+      - name: Install GitPython and cloudevents for pypi_packaging
+        run: pip install -U -r requirements/publish.txt
+      - name: Create Tag
+        run: python pypi_packaging.py
@@ -0,0 +1,4 @@
+[settings]
+line_length = 80
+multi_line_output = 3
+include_trailing_comma = True
@@ -0,0 +1,10 @@
+repos:
+-   repo: https://github.com/timothycrosley/isort/
+    rev: 5.0.4
+    hooks:
+    - id: isort
+-   repo: https://github.com/psf/black
+    rev: 19.10b0
+    hooks:
+    - id: black
+      language_version: python3.8
@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0]
+### Added
+- Added a user friendly CloudEvent class with data validation ([#36])
+- CloudEvent structured cloudevent support ([#47])
+
+### Removed
+- Removed support for Cloudevents V0.2 and V0.1 ([#43])
+
 ## [0.3.0]
 ### Added
 - Added Cloudevents V0.3 and V1 implementations ([#22])
@@ -66,3 +74,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#23]: https://github.com/cloudevents/sdk-python/pull/23
 [#25]: https://github.com/cloudevents/sdk-python/pull/25
 [#27]: https://github.com/cloudevents/sdk-python/pull/27
+[#36]: https://github.com/cloudevents/sdk-python/pull/36
+[#43]: https://github.com/cloudevents/sdk-python/pull/43
+[#47]: https://github.com/cloudevents/sdk-python/pull/47
@@ -1,5 +1,7 @@
 # Python SDK for [CloudEvents](https://github.com/cloudevents/spec)
 
+[![PyPI version](https://badge.fury.io/py/cloudevents.svg)](https://badge.fury.io/py/cloudevents)
+
 ## Status
 
 This SDK is still considered a work in progress, therefore things might (and
@@ -14,159 +16,87 @@ This SDK current supports the following versions of CloudEvents:
 
 Package **cloudevents** provides primitives to work with CloudEvents specification: https://github.com/cloudevents/spec.
 
-Parsing upstream structured Event from HTTP request:
+## Sending CloudEvents
 
-```python
-import io
-
-from cloudevents.sdk.event import v1
-from cloudevents.sdk import marshaller
-
-m = marshaller.NewDefaultHTTPMarshaller()
-
-event = m.FromRequest(
-    v1.Event(),
-    {"content-type": "application/cloudevents+json"},
-    io.StringIO(
-        """
-        {
-            "specversion": "1.0",
-            "datacontenttype": "application/json",
-            "type": "word.found.name",
-            "id": "96fb5f0b-001e-0108-6dfe-da6e2806f124",
-            "time": "2018-10-23T12:28:22.4579346Z",
-            "source": "<source-url>"
-        }
-        """
-    ),
-    lambda x: x.read(),
-)
-```
+Below we will provide samples on how to send cloudevents using the popular
+[`requests`](http://docs.python-requests.org) library.
 
-Parsing upstream binary Event from HTTP request:
+### Binary HTTP CloudEvent
 
 ```python
-import io
-
-from cloudevents.sdk.event import v1
-from cloudevents.sdk import marshaller
-
-m = marshaller.NewDefaultHTTPMarshaller()
-
-event = m.FromRequest(
-    v1.Event(),
-    {
-        "ce-specversion": "1.0",
-        "content-type": "application/json",
-        "ce-type": "word.found.name",
-        "ce-id": "96fb5f0b-001e-0108-6dfe-da6e2806f124",
-        "ce-time": "2018-10-23T12:28:22.4579346Z",
-        "ce-source": "<source-url>",
-    },
-    io.BytesIO(b"this is where your CloudEvent data"),
-    lambda x: x.read(),
-)
-```
+from cloudevents.http import CloudEvent, to_binary_http
+import requests
 
-Creating a minimal CloudEvent in version 0.1:
 
-```python
-from cloudevents.sdk.event import v1
-
-event = (
-    v1.Event()
-    .SetContentType("application/json")
-    .SetData('{"name":"john"}')
-    .SetEventID("my-id")
-    .SetSource("from-galaxy-far-far-away")
-    .SetEventTime("tomorrow")
-    .SetEventType("cloudevent.greet.you")
-)
+# This data defines a binary cloudevent
+attributes = {
+    "type": "com.example.sampletype1",
+    "source": "https://example.com/event-producer",
+}
+data = {"message": "Hello World!"}
+
+event = CloudEvent(attributes, data)
+headers, body = to_binary_http(event)
+
+# POST
+requests.post("<some-url>", data=body, headers=headers)
 ```
 
-Creating HTTP request from CloudEvent:
+### Structured HTTP CloudEvent
 
 ```python
-from cloudevents.sdk import converters
-from cloudevents.sdk import marshaller
-from cloudevents.sdk.converters import structured
-from cloudevents.sdk.event import v1
-
-event = (
-    v1.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()])
-
-headers, body = m.ToRequest(event, converters.TypeStructured, lambda x: x)
-```
+from cloudevents.http import CloudEvent, to_structured_http
+import requests
 
-## HOWTOs with various Python HTTP frameworks
 
-In this topic you'd find various example how to integrate an SDK with various HTTP frameworks.
+# This data defines a structured cloudevent
+attributes = {
+    "type": "com.example.sampletype2",
+    "source": "https://example.com/event-producer",
+}
+data = {"message": "Hello World!"}
+event = CloudEvent(attributes, data)
+headers, body = to_structured_http(event)
 
-### Python requests
+# POST
+requests.post("<some-url>", data=body, headers=headers)
+```
 
-One of popular framework is [`requests`](http://docs.python-requests.org/en/master/).
+You can find a complete example of turning a CloudEvent into a HTTP request [in the samples directory](samples/http-json-cloudevents/client.py).
 
-#### CloudEvent to request
+#### Request to CloudEvent
 
-The code below shows how integrate both libraries in order to convert a CloudEvent into an HTTP request:
+The code below shows how to consume a cloudevent using the popular python web framework
+[flask](https://flask.palletsprojects.com/en/1.1.x/quickstart/):
 
 ```python
-def run_binary(event, url):
-    binary_headers, binary_data = http_marshaller.ToRequest(
-        event, converters.TypeBinary, json.dumps)
-
-    print("binary CloudEvent")
-    for k, v in binary_headers.items():
-        print("{0}: {1}\r\n".format(k, v))
-    print(binary_data.getvalue())
-    response = requests.post(url,
-                             headers=binary_headers,
-                             data=binary_data.getvalue())
-    response.raise_for_status()
-
-
-def run_structured(event, url):
-    structured_headers, structured_data = http_marshaller.ToRequest(
-        event, converters.TypeStructured, json.dumps
-    )
-    print("structured CloudEvent")
-    print(structured_data.getvalue())
+from flask import Flask, request
 
-    response = requests.post(url,
-                             headers=structured_headers,
-                             data=structured_data.getvalue())
-    response.raise_for_status()
+from cloudevents.http import from_http
 
-```
+app = Flask(__name__)
 
-Complete example of turning a CloudEvent into a request you can find [here](samples/python-requests/cloudevent_to_request.py).
 
-#### Request to CloudEvent
+# create an endpoint at http://localhost:/3000/
+@app.route("/", methods=["POST"])
+def home():
+    # create a CloudEvent
+    event = from_http(request.get_data(), request.headers)
 
-The code below shows how integrate both libraries in order to create a CloudEvent from an HTTP request:
+    # you can access cloudevent fields as seen below
+    print(
+        f"Found {event['id']} from {event['source']} with type "
+        f"{event['type']} and specversion {event['specversion']}"
+    )
 
-```python
-    response = requests.get(url)
-    response.raise_for_status()
-    headers = response.headers
-    data = io.BytesIO(response.content)
-    event = v1.Event()
-    http_marshaller = marshaller.NewDefaultHTTPMarshaller()
-    event = http_marshaller.FromRequest(
-        event, headers, data, json.load)
+    return "", 204
 
+
+if __name__ == "__main__":
+    app.run(port=3000)
 ```
 
-Complete example of turning a CloudEvent into a request you can find [here](samples/python-requests/request_to_cloudevent.py).
+You can find a complete example of turning a CloudEvent into a HTTP request [in the samples directory](samples/http-json-cloudevents/server.py).
 
 ## SDK versioning
 
@@ -189,3 +119,17 @@ the same API. It will use semantic versioning with following rules:
   [CNCF's Slack workspace](https://slack.cncf.io/).
 - Email: https://lists.cncf.io/g/cncf-cloudevents-sdk
 - Contact for additional information: Denis Makogon (`@denysmakogon` on slack).
+
+## Maintenance
+
+We use black and isort for autoformatting. We setup a tox environment to reformat
+the codebase.
+
+e.g.
+
+```python
+pip install tox
+tox -e reformat
+```
+
+For information on releasing version bumps see [RELEASING.md](RELEASING.md)
@@ -0,0 +1,25 @@
+# Releasing CloudEvents SDK for Python
+
+This repository is configured to automatically publish the corresponding [PyPI
+package](https://pypi.org/project/cloudevents/) and GitHub Tag via GitHub Actions.
+
+To release a new CloudEvents SDK, contributors should bump `__version__` in
+[cloudevents](cloudevents/__init__.py) to reflect the new release version. On merge, the action
+will automatically build and release to PyPI using
+[this PyPI GitHub Action](https://github.com/pypa/gh-action-pypi-publish). This
+action gets called on all pushes to master (such as a version branch being merged
+into master), but only releases a new version when the version number has changed. Note,
+this action assumes pushes to master are version updates. Consequently,
+[pypi-release.yml](.github/workflows/pypi-release.yml) will fail if you attempt to
+push to master without updating `__version__` in
+[cloudevents](cloudevents/__init__.py) so don't forget to do so.
+
+After a version update is merged, the script [pypi_packaging.py](pypi_packaging.py)
+will create a GitHub tag for the new cloudevents version using `__version__`.
+The script fails if `__version__` and the local pypi version for
+cloudevents are out of sync. For this reason, [pypi-release.yml](.github/workflows/pypi-release.yml)
+first must upload the new cloudevents pypi package, and then download the recently updated pypi
+cloudevents package for [pypi_packaging.py](pypi_packaging.py) not to fail.
+
+View the GitHub workflow [pypi-release.yml](.github/workflows/pypi-release.yml) for
+more information.
@@ -0,0 +1 @@
+__version__ = "1.0.0"
@@ -0,0 +1,23 @@
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+import json
+import typing
+
+from cloudevents.http.event import CloudEvent
+from cloudevents.http.http_methods import (
+    from_http,
+    to_binary_http,
+    to_structured_http,
+)
+from cloudevents.http.json_methods import from_json, to_json