Version 1.5.0 (#69)

* Revert "Version 2.0.0 (#67)" This reverts commit f2471b4. * Revert "Add Cloud Events support for #55 (#56) (#64)" This reverts commit 8f3fe35. * Version 1.5.0
GoogleCloudPlatform · Jul 6, 2020 · 6f0d848 · 6f0d848
1 parent f2471b4
commit 6f0d848
Show file tree

Hide file tree

Showing 17 changed files with 224 additions and 609 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,10 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [2.0.0] - 2020-07-01
-### Added
-- Support `cloudevent` signature type ([#55], [#56])
-
+## [1.5.0] - 2020-07-06
 ### Changed
 - Framework will consume entire request before responding ([#66])
 
@@ -70,8 +67,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/GoogleCloudPlatform/functions-framework-python/compare/v2.0.0...HEAD
-[2.0.0]: https://github.com/GoogleCloudPlatform/functions-framework-python/releases/tag/v2.0.0
+[Unreleased]: https://github.com/GoogleCloudPlatform/functions-framework-python/compare/v1.5.0...HEAD
+[1.5.0]: https://github.com/GoogleCloudPlatform/functions-framework-python/releases/tag/v1.5.0
 [1.4.4]: https://github.com/GoogleCloudPlatform/functions-framework-python/releases/tag/v1.4.4
 [1.4.3]: https://github.com/GoogleCloudPlatform/functions-framework-python/releases/tag/v1.4.3
 [1.4.2]: https://github.com/GoogleCloudPlatform/functions-framework-python/releases/tag/v1.4.2
@@ -86,8 +83,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [#66]: https://github.com/GoogleCloudPlatform/functions-framework-python/pull/66
 [#61]: https://github.com/GoogleCloudPlatform/functions-framework-python/pull/61
-[#56]: https://github.com/GoogleCloudPlatform/functions-framework-python/pull/56
-[#55]: https://github.com/GoogleCloudPlatform/functions-framework-python/pull/55
 [#49]: https://github.com/GoogleCloudPlatform/functions-framework-python/pull/49
 [#44]: https://github.com/GoogleCloudPlatform/functions-framework-python/pull/44
 [#38]: https://github.com/GoogleCloudPlatform/functions-framework-python/pull/38

diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ pip install functions-framework
 Or, for deployment, add the Functions Framework to your `requirements.txt` file:
 
 ```
-functions-framework==2.0.0
+functions-framework==1.5.0
 ```
 
 # Quickstart: Hello, World on your local machine
@@ -129,57 +129,27 @@ You can configure the Functions Framework using command-line flags or environmen
 | `--host`           | `HOST`                    | The host on which the Functions Framework listens for requests. Default: `0.0.0.0`                                                                                                               |
 | `--port`           | `PORT`                    | The port on which the Functions Framework listens for requests. Default: `8080`                                                                                                                  |
 | `--target`         | `FUNCTION_TARGET`         | The name of the exported function to be invoked in response to requests. Default: `function`                                                                                                     |
-| `--signature-type` | `FUNCTION_SIGNATURE_TYPE` | The signature used when writing your function. Controls unmarshalling rules and determines which arguments are used to invoke your function. Default: `http`; accepted values: `http` or `event` or `cloudevent` |
+| `--signature-type` | `FUNCTION_SIGNATURE_TYPE` | The signature used when writing your function. Controls unmarshalling rules and determines which arguments are used to invoke your function. Default: `http`; accepted values: `http` or `event` |
 | `--source`         | `FUNCTION_SOURCE`         | The path to the file containing your function. Default: `main.py` (in the current working directory)                                                                                             |
 | `--debug`          | `DEBUG`                   | A flag that allows to run functions-framework to run in debug mode, including live reloading. Default: `False`                                                                                   |
 
+# Enable CloudEvents
 
-# Enable Google Cloud Functions Events
-
-The Functions Framework can unmarshall incoming
-Google Cloud Functions [event](https://cloud.google.com/functions/docs/concepts/events-triggers#events) payloads to `data` and `context` objects.
-These will be passed as arguments to your function when it receives a request.
-Note that your function must use the `event`-style function signature:
-
+The Functions Framework can unmarshall incoming [CloudEvents](http://cloudevents.io) payloads to `data` and `context` objects.  These will be passed as arguments to your function when it receives a request.  Note that your function must use the event-style function signature:
 
 ```python
 def hello(data, context):
     print(data)
     print(context)
 ```
 
-To enable automatic unmarshalling, set the function signature type to `event`
-using a command-line flag or an environment variable. By default, the HTTP
-signature will be used and automatic event unmarshalling will be disabled.
-
-For more details on this signature type, check out the Google Cloud Functions
-documentation on
-[background functions](https://cloud.google.com/functions/docs/writing/background#cloud_pubsub_example).
-
-See the [running example](examples/cloud_run_event).
-
-# Enable CloudEvents
-
-The Functions Framework can unmarshall incoming
-[CloudEvent](http://cloudevents.io) payloads to a `cloudevent` object.
-It will be passed as an argument to your function when it receives a request.
-Note that your function must use the `cloudevent`-style function signature
-
-
-```python
-def hello(cloudevent):
-    print("Received event with ID: %s" % cloudevent.EventID())
-    return 200
-```
-
-To enable automatic unmarshalling, set the function signature type to `cloudevent` using the `--signature-type` command-line flag or the `FUNCTION_SIGNATURE_TYPE` environment variable. By default, the HTTP signature type will be used and automatic event unmarshalling will be disabled.
+To enable automatic unmarshalling, set the function signature type to `event` using the `--signature-type` command-line flag or the `FUNCTION_SIGNATURE_TYPE` environment variable. By default, the HTTP signature type will be used and automatic event unmarshalling will be disabled.
 
-See the [running example](examples/cloud_run_cloudevents).
+For more details on this signature type, check out the Google Cloud Functions documentation on [background functions](https://cloud.google.com/functions/docs/writing/background#cloud_pubsub_example).
 
 # Advanced Examples
 
-More advanced guides can be found in the [`examples/`](./examples/) directory. You can also find examples
-on using the CloudEvent Python SDK [here](https://github.com/cloudevents/sdk-python).
+More advanced guides can be found in the [`examples/`](./examples/) directory.
 
 # Contributing
 

diff --git a/examples/README.md b/examples/README.md
@@ -1,5 +1,4 @@
 # Python Functions Frameworks Examples
 
 * [`cloud_run_http`](./cloud_run_http/) - Deploying an HTTP function to [Cloud Run](http://cloud.google.com/run) with the Functions Framework
-* [`cloud_run_event`](./cloud_run_event/) - Deploying a [Google Cloud Functions Event](https://cloud.google.com/functions/docs/concepts/events-triggers#events) function to [Cloud Run](http://cloud.google.com/run) with the Functions Framework
-* [`cloud_run_cloudevents`](./cloud_run_cloudevents/) - Deploying a [CloudEvent](https://github.com/cloudevents/sdk-python) function to [Cloud Run](http://cloud.google.com/run) with the Functions Framework
+* [`cloud_run_event`](./cloud_run_event/) - Deploying a CloudEvent function to [Cloud Run](http://cloud.google.com/run) with the Functions Framework
diff --git a/examples/cloud_run_cloudevents/Dockerfile b/examples/cloud_run_cloudevents/Dockerfile
diff --git a/examples/cloud_run_cloudevents/README.md b/examples/cloud_run_cloudevents/README.md
diff --git a/examples/cloud_run_cloudevents/main.py b/examples/cloud_run_cloudevents/main.py
diff --git a/examples/cloud_run_cloudevents/requirements.txt b/examples/cloud_run_cloudevents/requirements.txt
diff --git a/examples/cloud_run_event/Dockerfile b/examples/cloud_run_event/Dockerfile
@@ -12,4 +12,4 @@ RUN pip install gunicorn functions-framework
 RUN pip install -r requirements.txt
 
 # Run the web service on container startup.
-CMD exec functions-framework --target=hello --signature_type=event
+CMD exec functions-framework --target=hello --signature-type=event
diff --git a/examples/cloud_run_event/README.md b/examples/cloud_run_event/README.md
diff --git a/setup.py b/setup.py
@@ -25,7 +25,7 @@
 
 setup(
     name="functions-framework",
-    version="2.0.0",
+    version="1.5.0",
     description="An open source FaaS (Function as a service) framework for writing portable Python functions -- brought to you by the Google Cloud Functions team.",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -52,7 +52,6 @@
         "click>=7.0,<8.0",
         "watchdog>=0.10.0",
         "gunicorn>=19.2.0,<21.0; platform_system!='Windows'",
-        "cloudevents<1.0",
     ],
     entry_points={
         "console_scripts": [