refactor!: rename cloudevent to cloud_event (GoogleCloudPlatform#167)

Author: KaylaNguyen

.github/workflows/conformance.yml

@@ -41,7 +41,7 @@ jobs:
         validateMapping: true
         cmd: "'functions-framework --source tests/conformance/main.py --target write_legacy_event --signature-type event'"
 
-    - name: Run cloudevent conformance tests
+    - name: Run CloudEvents conformance tests
       uses: GoogleCloudPlatform/functions-framework-conformance/action@v1.1.0
       with:
         version: 'v1.1.0'
@@ -59,11 +59,11 @@ jobs:
         validateMapping: false
         cmd: "'functions-framework --source tests/conformance/main.py --target write_http_declarative'"
 
-    - name: Run cloudevent conformance tests declarative
+    - name: Run CloudEvents conformance tests declarative
       uses: GoogleCloudPlatform/functions-framework-conformance/action@v1.1.0
       with:
         version: 'v1.1.0'
         functionType: 'cloudevent'
         useBuildpacks: false
         validateMapping: true
-        cmd: "'functions-framework --source tests/conformance/main.py --target write_cloudevent_declarative'"
+        cmd: "'functions-framework --source tests/conformance/main.py --target write_cloud_event_declarative'"

README.md

@@ -118,9 +118,9 @@ Create an `main.py` file with the following contents:
 ```python
 import functions_framework
 
-@functions_framework.cloudevent
-def hello_cloudevent(cloudevent):
-   return f"Received event with ID: {cloudevent['id']} and data {cloudevent.data}"
+@functions_framework.cloud_event
+def hello_cloud_event(cloud_event):
+   return f"Received event with ID: {cloud_event['id']} and data {cloud_event.data}"
 
 @functions_framework.http
 def hello_http(request):
@@ -136,13 +136,13 @@ functions-framework --target=hello_http
 
 Open http://localhost:8080/ in your browser and see *Hello world!*.
 
-Run the following command to run `hello_cloudevent` target locally:
+Run the following command to run `hello_cloud_event` target locally:
 
 ```sh
-functions-framework --target=hello_cloudevent
+functions-framework --target=hello_cloud_event
 ```
 
-More info on sending [CloudEvents](http://cloudevents.io) payloads, see [`examples/cloud_run_cloudevents`](examples/cloud_run_cloudevents/) instruction.
+More info on sending [CloudEvents](http://cloudevents.io) payloads, see [`examples/cloud_run_cloud_events`](examples/cloud_run_cloud_events/) instruction.
 
 
 ### Quickstart: Error handling
@@ -358,11 +358,11 @@ See the [running example](examples/cloud_run_event).
 
 ## Enable CloudEvents
 
-The Functions framework can also unmarshall incoming [CloudEvents](http://cloudevents.io) payloads to the `cloudevent` object. This will be passed as a [cloudevent](https://github.com/cloudevents/sdk-python) to your function when it receives a request.  Note that your function must use the `cloudevents`-style function signature:
+The Functions framework can also unmarshall incoming [CloudEvents](http://cloudevents.io) payloads to the `cloud_event` object. This will be passed as a [CloudEvent](https://github.com/cloudevents/sdk-python) to your function when it receives a request.  Note that your function must use the `CloudEvents`-style function signature:
 
 ```python
-def hello(cloudevent):
-    print(f"Received event with ID: {cloudevent['id']}")
+def hello(cloud_event):
+    print(f"Received event with ID: {cloud_event['id']}")
 ```
 
 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.

examples/README.md

@@ -4,7 +4,7 @@
 ### Cloud Run
 * [`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 CloudEvent 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_cloud_events`](cloud_run_cloud_events/) - Deploying a [CloudEvent](https://github.com/cloudevents/sdk-python) function to [Cloud Run](http://cloud.google.com/run) with the Functions Framework
 
 ## Development Tools
 * [`docker-compose`](./docker-compose) -

examples/cloud_run_cloudevents/Dockerfile renamed to examples/cloud_run_cloud_events/Dockerfile

@@ -7,17 +7,17 @@ This sample uses the [CloudEvents SDK](https://github.com/cloudevents/sdk-python
 Build the Docker image:
 
 ```commandline
-docker build -t cloudevent_example .
+docker build -t cloud_event_example .
 ```
 
 Run the image and bind the correct ports:
 
 ```commandline
-docker run --rm -p 8080:8080 -e PORT=8080 cloudevent_example
+docker run --rm -p 8080:8080 -e PORT=8080 cloud_event_example
 ```
 
 Send an event to the container:
 
 ```python
-docker run -t cloudevent_example send_cloudevent.py
+docker run -t cloud_event_example send_cloud_event.py
 ```

examples/cloud_run_cloudevents/README.md renamed to examples/cloud_run_cloud_events/README.md

@@ -16,5 +16,5 @@
 # (https://github.com/cloudevents/sdk-python)
 
 
-def hello(cloudevent):
-    print(f"Received event with ID: {cloudevent['id']} and data {cloudevent.data}")
+def hello(cloud_event):
+    print(f"Received event with ID: {cloud_event['id']} and data {cloud_event.data}")

examples/cloud_run_cloudevents/main.py renamed to examples/cloud_run_cloud_events/main.py

@@ -1,7 +1,7 @@
 ## How to run this locally
 
 This guide shows how to run `hello_http` target locally.
-To test with `hello_cloudevent`, change the target accordingly in Dockerfile.
+To test with `hello_cloud_event`, change the target accordingly in Dockerfile.
 
 Build the Docker image:
 

examples/cloud_run_cloudevents/requirements.txt renamed to examples/cloud_run_cloud_events/requirements.txt

@@ -17,9 +17,9 @@
 import functions_framework
 
 
-@functions_framework.cloudevent
-def hello_cloudevent(cloudevent):
-    return f"Received event with ID: {cloudevent['id']} and data {cloudevent.data}"
+@functions_framework.cloud_event
+def hello_cloud_event(cloud_event):
+    return f"Received event with ID: {cloud_event['id']} and data {cloud_event.data}"
 
 
 @functions_framework.http