README.md

Kino Membrane

Utilities for introspecting Membrane pipelines in Livebook.

Installation

The package can be installed by adding kino_membrane to your list of dependencies in mix.exs:

def deps do
  [
	{:kino_membrane, "~> 0.2.0"}
  ]
end

or by calling

Mix.install([:kino_membrane])

Usage

To run the pipeline dashboard, install :kino_membrane as described above, and type the following in a Livebook cell:

KinoMembrane.pipeline_dashboard(pipeline)

The pipeline can either be started within the Livebook (see example) or you can connect to a node where the pipeline is running (see example).

Development

This package contains JavaScript subproject. It's precompiled, so you only need to compile them if you change its code or need to generate a source map. In that case, run

mix setup # fetches JS and Elixir deps
mix build # compiles JS and Elixir code

or compile each project manually

npm ci --prefix assets
npm run build --prefix assets
mix deps.get
mix compile

Copyright and License

Copyright 2020, Software Mansion

Licensed under the Apache License, Version 2.0