cloudevents-ex

KO | EN

gitlite — search

#python #react #ai #golang #android #deep-learning #linux #docker #macos #nodejs #kubernetes #awesome-list #pytorch #ios

(★ 16)

Elixir SDK for CloudEvents

cloudevents-ex Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Hex pm](https://img.shields.io/hexpm/v/cloudevents.svg?style=flat-square)](https://hex.pm/packages/cloudevents)
[![Hex Docs](https://img.shields.io/badge/api-docs-blue.svg?style=flat-square)](https://hexdocs.pm/cloudevents)
[![Apache 2.0 license](https://img.shields.io/hexpm/l/cloudevents.svg?style=flat-square)](https://raw.githubusercontent.com/kevinbader/cloudevents-ex/master/LICENSE)

</span>

Cloudevents is an Elixir [SDK] for consuming and producing [CloudEvents] with support for various transport protocols and codecs. If you want to learn more about the specification itself, make sure to check out the [official spec on GitHub].

Cloudevents is released under the Apache License 2.0 - see the [LICENSE](LICENSE) file.

[CloudEvents]: https://cloudevents.io/
[SDK]: https://github.com/cloudevents/spec/blob/master/SDK.md
[official spec on GitHub]: https://github.com/cloudevents/spec

## Supported versions

* OTP 25.0 and later
* Elixir 1.13 and later

## Status

</div>

## Getting started

Add `cloudevents` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [{:cloudevents, "~> 0.6.1"}]
end
```

Use `Cloudevents.from_map/1` to create your first Cloudevent and see its JSON representation using `Cloudevents.to_json/1`.

If you're dealing with HTTP requests, `Cloudevents.from_http_message/2`, `Cloudevents.to_http_binary_message/1` and `Cloudevents.to_http_structured_message/2` are your friends.

If you need Avro, you need to add `avrora` to your dependency list:
```elixir
def deps do
  [{:avrora, "~> 0.21"}]
end
```

Then, you need to add `Cloudevents` to your supervisor:

```elixir
children = [
  Cloudevents
]

Supervisor.start_link(children, strategy: :one_for_one)
```

Or start `Cloudevents` manually:

```elixir
{:ok, pid} = Cloudevents.start_link([])
```

cloudevents-ex

cloudevents-ex Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

cloudevents-ex

cloudevents-ex Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README