https://github.com/membraneframework/kino_membrane

Utilities for introspecting Membrane pipelines in Livebook
https://github.com/membraneframework/kino_membrane

Last synced: 2 months ago
JSON representation

Utilities for introspecting Membrane pipelines in Livebook

• Host: GitHub
• URL: https://github.com/membraneframework/kino_membrane
• Owner: membraneframework
• License: apache-2.0
• Created: 2023-06-20T16:03:18.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-05T12:20:22.000Z (almost 2 years ago)
• Last Synced: 2025-09-07T10:36:06.378Z (9 months ago)
• Language: Elixir
• Homepage:
• Size: 322 KB
• Stars: 11
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Kino Membrane

[![Hex.pm](https://img.shields.io/hexpm/v/kino_membrane.svg)](https://hex.pm/packages/kino_membrane)

[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/kino_membrane)

[![CircleCI](https://circleci.com/gh/membraneframework/kino_membrane.svg?style=svg)](https://circleci.com/gh/membraneframework/kino_membrane)

Utilities for introspecting [Membrane](https://membrane.stream) pipelines in [Livebook](https://livebook.dev/).

![kino_membrane](https://github.com/membraneframework/kino_membrane/assets/16493463/8606e631-a851-4234-93b9-db8eeb3cdfe4)

## Installation

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

```elixir

def deps do

  [

	{:kino_membrane, "~> 0.2.0"}

  ]

end

```

or by calling

```elixir

Mix.install([:kino_membrane])

```

## Usage

To run the pipeline dashboard, install `:kino_membrane` as described above, and type the following in a [Livebook](https://livebook.dev/) cell:

```elixir

KinoMembrane.pipeline_dashboard(pipeline)

```

The pipeline can either be started within the Livebook (see [example](examples/pipeline_in_livebook.livemd)) or you can connect to a node where the pipeline is running (see [example](examples/connect_to_node.livemd)).

## 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

```sh

mix setup # fetches JS and Elixir deps

mix build # compiles JS and Elixir code

```

or compile each project manually

```sh

npm ci --prefix assets

npm run build --prefix assets

mix deps.get

mix compile

```

## Copyright and License

Copyright 2020, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=kino_membrane)

[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=kino_membrane)

Licensed under the [Apache License, Version 2.0](LICENSE)