Prepare for publishing

Author: benjreinhart

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Ben Reinhart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,6 +1,6 @@
 # ServerSentEvents
 
-This module implements a performant [Server Sent Event](https://en.wikipedia.org/wiki/Server-sent_events) parser.
+Efficient and fully spec conformant Server Sent Event parser for Elixir.
 
 ## Usage
 
@@ -28,6 +28,59 @@ IO.inspect(rest)     # ""
 
 This can be useful for streaming environments where a single event may not reliably arrive in one chunk.
 
+## Real world example
+
+AI providers like OpenAI and Anthropic stream AI generated messages using Server Sent Events.
+This module can handle parsing the server sent events, returning a list of maps. For example,
+we can parse a streaming response from Anthropic:
+
+```elixir
+Req.post("https://api.anthropic.com/v1/messages",
+  json: request,
+  into: fn {:data, data}, {req, res} ->
+    buffer = Request.get_private(req, :sse_buffer, "")
+    {events, buffer} = ServerSentEvents.parse(buffer <> data)
+    Request.put_private(req, :sse_buffer, buffer)
+
+    if events != [] do
+      # Do something with events, e.g., send to a process consuming them.
+      send(pid, {:events, events})
+    end
+
+    {:cont, {req, res}}
+  end,
+  headers: %{
+    "x-api-key" => api_key(),
+    "anthropic-version" => "2023-06-01"
+  }
+)
+```
+
+The first chunk from Anthropic tends to contain a couple of messages that look something like the following when parsed by this module:
+
+```elixir
+# Parsing first chunk from Anthropic
+{events, ""} = ServerSentEvents.parse(chunk)
+IO.inspect(events)
+# [
+#   %{
+#     "data" => "{\"type\":\"message_start\",\"message\":{\"id\":\"msg_01LAFhYgKvtBB5ac5n41oyDn\",\"type\":\"message\",\"role\":\"assistant\",\"model\":\"claude-3-5-sonnet-20241022\",\"content\":[],\"stop_reason\":null,\"stop_sequence\":null,\"usage\":{\"input_tokens\":12,\"output_tokens\":2}}        }",
+#     "event" => "message_start"
+#   },
+#   %{
+#     "data" => "{\"type\":\"content_block_start\",\"index\":0,\"content_block\":{\"type\":\"text\",\"text\":\"\"}         }",
+#     "event" => "content_block_start"
+#   },
+#   %{"data" => "{\"type\": \"ping\"}", "event" => "ping"},
+#   %{
+#     "data" => "{\"type\":\"content_block_delta\",\"index\":0,\"delta\":{\"type\":\"text_delta\",\"text\":\"Here's\"}          }",
+#     "event" => "content_block_delta"
+#   }
+# ]
+```
+
+This is typically followed by filtering out unwanted events and JSON parsing the `data` field of meaningful events.
+
 ## Installation
 
 The package can be installed by adding `server_sent_events` to your list of dependencies in `mix.exs`:

lib/server_sent_events.ex

@@ -1,8 +1,9 @@
 defmodule ServerSentEvents do
   @moduledoc """
-  This module implements a performant [Server Sent Event](https://en.wikipedia.org/wiki/Server-sent_events) parser.
+  This module is an efficient and fully spec conformant Server Sent Event parser.
 
-  The parser fully conforms to the [Server-Sent Events spec](https://html.spec.whatwg.org/multipage/server-sent-events.html).
+  - https://en.wikipedia.org/wiki/Server-sent_events
+  - https://html.spec.whatwg.org/multipage/server-sent-events.html
   """
 
   @doc ~s"""

mix.exs

@@ -1,28 +1,48 @@
 defmodule ServerSentEvents.MixProject do
   use Mix.Project
 
+  @github_repo_url "https://github.com/benjreinhart/server_sent_events"
+
+  @description "Efficient and fully spec conformant Server Sent Event parser"
+
   def project do
     [
       app: :server_sent_events,
       version: "0.1.0",
       elixir: "~> 1.12",
       start_permanent: Mix.env() == :prod,
+      name: "Server Sent Events",
+      description: @description,
+      source_url: @github_repo_url,
+      homepage_url: @github_repo_url,
+      package: package(),
       deps: deps()
     ]
   end
 
-  # Run "mix help compile.app" to learn about applications.
   def application do
     [
       extra_applications: [:logger]
     ]
   end
 
-  # Run "mix help deps" to learn about dependencies.
+  def description do
+    @description
+  end
+
+  def package do
+    [
+      maintainers: ["Ben Reinhart"],
+      licenses: ["MIT"],
+      links: %{
+        "GitHub" => @github_repo_url
+      }
+    ]
+  end
+
   defp deps do
     [
-      # {:dep_from_hexpm, "~> 0.3.0"},
-      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
+      {:ex_doc, ">= 0.0.0", only: :dev, runtime: false}
     ]
   end
 end

mix.lock

@@ -0,0 +1,8 @@
+%{
+  "earmark_parser": {:hex, :earmark_parser, "1.4.41", "ab34711c9dc6212dda44fcd20ecb87ac3f3fce6f0ca2f28d4a00e4154f8cd599", [:mix], [], "hexpm", "a81a04c7e34b6617c2792e291b5a2e57ab316365c2644ddc553bb9ed863ebefa"},
+  "ex_doc": {:hex, :ex_doc, "0.34.2", "13eedf3844ccdce25cfd837b99bea9ad92c4e511233199440488d217c92571e8", [:mix], [{:earmark_parser, "~> 1.4.39", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "5ce5f16b41208a50106afed3de6a2ed34f4acfd65715b82a0b84b49d995f95c1"},
+  "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
+  "makeup_elixir": {:hex, :makeup_elixir, "1.0.0", "74bb8348c9b3a51d5c589bf5aebb0466a84b33274150e3b6ece1da45584afc82", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "49159b7d7d999e836bedaf09dcf35ca18b312230cf901b725a64f3f42e407983"},
+  "makeup_erlang": {:hex, :makeup_erlang, "1.0.1", "c7f58c120b2b5aa5fd80d540a89fdf866ed42f1f3994e4fe189abebeab610839", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "8a89a1eeccc2d798d6ea15496a6e4870b75e014d1af514b1b71fa33134f57814"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.4.0", "51f9b613ea62cfa97b25ccc2c1b4216e81df970acd8e16e8d1bdc58fef21370d", [:mix], [], "hexpm", "9c565862810fb383e9838c1dd2d7d2c437b3d13b267414ba6af33e50d2d1cf28"},
+}