Skip to content

zorbash/opus_graph

Repository files navigation

Opus.Graph

Build Status Package Version Coverage Status

A complementary package for Opus which visualises pipelines using Graphviz.

Installation

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

def deps do
  [{:opus_graph, "~> 0.1"}]
end

Documentation

Usage

Opus.Graph.generate(:your_app)
# => {:ok, "Graph file has been written to your_app_opus_graph.png"}

This feature uses graphviz, so make sure to have it installed. To install it:

# MacOS

brew install graphviz
# Debian / Ubuntu

apt-get install graphviz

Opus.Graph is in fact a pipeline and its visualisation is:

graph-png

You can customise the visualisation:

Opus.Graph.generate(:your_app, %{filetype: :svg})
# => {:ok, "Graph file has been written to your_app_opus_graph.svg"}

Read the available visualisation options here.

License

Copyright (c) 2018 Dimitris Zorbas, MIT License. See LICENSE.txt for further details.

About

Graph visualization for Opus pipelines

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages