opus_graph v0.1.0 Opus.Graph View Source

Generates a Graph with all the pipeline modules, their stages and their relationships when there are links.

Make sure to have Graphviz installed before using this.

Usage:

Opus.Graph.generate(:awesome_app, %{filetype: :png, filename: "my_graph"})

The above will create a my_graph.png graph image at the current working directory.

Configuration:

  • filetype: The output format. Must be one of: [:svg, :png, :pdf]. Defaults to: :png

  • docs_base_url: The prefix part of the documentation URLs set as hrefs for graph nodes. Defaults to: ""

  • theme: A map of options on how the graph should be styled. Defaults to:

%{
  colors: %{
    background: %{
      check: "#7FB3D5",
      link: "#C39BD3",
      pipeline: "#DDDDDD",
      step: "#73C6B6",
      tee: "#A6ACAF"
    },
    border: %{conditional: "#F9E79F", normal: "#222222", pipeline: "#222222"},
    edges: %{link: "purple", normal: "black"}
  },
  penwidth: 2,
  stage_shape: "box",
  style: %{conditional: "filled, dashed", normal: "filled"}
}

Link to this section Summary

Link to this section Functions

Link to this function call(input, opts \\ %{}) View Source
Link to this function generate(app, config \\ nil) View Source