event-gateway-sdk 1.2.0
Event Gateway Python SDK

# Event Gateway Python SDK

Python library for interacting with the [Event Gateway](https://github.com/serverless/event-gateway).

## Contents

- [Background](#background)
- [Installation](#installation)
- [Usage](#usage)
- [Constructor](#constructor)
- [Available Functions](#available-functions)
- [Contributing](#contributing)

## Background

This is the Python SDK for interacting with the [Event Gateway](https://github.com/serverless/event-gateway), the hub for connecting events to serverless functions.

## Installation

```
pip install event-gateway-sdk
```

## Usage

Use the `emit` command to emit a [CloudEvent](https://github.com/cloudevents/spec) payload to your Event Gateway. The event will be received by any function that is subscribed to your event.

```python
from eventgateway import EventGateway

eg = EventGateway(url="https://mytenant-myapp.slsgateway.com")
cloudEvent = {
    "eventType": "user.created",
    "cloudEventsVersion": "0.1",
    "source": "/services/users",
    "data": {
        "userId": "foo",
        "userName": "bar"
    }
}
eg.emit(cloudEvent=configData, path="/user/send-mail-user")
```

The `emit()` function takes three arguments: 
- an `event` which is a valid CloudEvent,
- a `path` which is the path associated to the function (default: `/`)
- a `headers` object that represents the headers sent to the gateway (default: `{"Content-type": "application/json"}`)

The function returns a request object. If your event has a `sync` subscription attached, the `fetch` response will have the status code and body from the subscription. If not, the response will return a `202 Accepted` status code with an empty body.

## Constructor

In the example above, we created an Event Gateway client using the application URL from the [hosted Event Gateway](https://dashboard.serverless.com/) provided by Serverless, Inc. 

You can also use the Event Gateway SDK with your own, self-hosted Event Gateway. Constructor details are listed below.

**Parameters**

- `url` - `string` - optional, Events API URL, default: `http://localhost:4000`
- `space` - `string` - optional, space name, default: `default`
- `configurationUrl` - `string` - optional, Configuration API URL. By default, it's the same as `url` but with `4001` port
- `connectorUrl` - `string` - optional, Connector API URL. By default, it's the same as `url` but with `4002` port
- `accessKey` - `string` - optional, access key for hosted Event Gateway. Access key is required for using Configuration API methods on hosted Event Gateway

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway(url="https://mytenant-myapp.slsgateway.com", space="user")
```

## Available Functions

### checkConnection

Used to check the connectivity to the Event Gateway (using the `/v1/status` endpoint).

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway()
if eg.checkConnection():
    print("Connection succesfull")
else:
    print("Issue while connecting")
```

### printConfig

Utility to print the current configuration.

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway()
eg.printConfig()
```

### createEventType

Function to create an event type.

**Example**

```python
from eventgateway import EventGateway

eventtype = {
    "name": "http.request"
}
eg = EventGateway()
eg.createEventType(eventtype)
```

### getEventType

Function to get an event type.

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway()
eg.getEventType("user.created")
```

### getAllEventType

Function to get all event type.

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway()
eg.getAllEventType()
```

### createFunction

Function to create a function trigger.

**Example**

```python
from eventgateway import EventGateway

function = {
    "functionId": "new-user",
    "type": "http",
    "provider":{
        "url": "http://myapp.com/user/new"
    }
}
eg = EventGateway()
eg.createFunction(function)
```

### getFunction

Function to get a function.

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway()
eg.getFunction("new-user")
```

### getAllFunction

Function to get all functions.

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway()
eg.getAllFunction()
```

### createSubscription

Function to subscribe to a function.

**Example**

```python
from eventgateway import EventGateway

subscription = {
    "functionId": "new-user",
    "event": "http",
    "method": "POST",
    "path": "/user/new",
    "eventType": "http.request",
    "type": "async"
}
eg = EventGateway()
eg.createSubscription(subscription)
```

### getSubscription

Function to get a subscription.

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway()
eg.getSubscription("YXN5bmMsaHR0cC5yZXF1ZXN0LG5ldy11c2VyLW9wZW5wYWFzLCUyRmppcmE")
```

### getAllSubscription

Function to get all subscription.

**Example**

```python
from eventgateway import EventGateway

eg = EventGateway()
eg.getAllSubscription()
```

## Contribute

TBD