Skip to content

Commit

Permalink
docs: minor update and typo
Browse files Browse the repository at this point in the history
  • Loading branch information
iamaziz committed Jan 4, 2021
1 parent 73d249e commit 72c1667
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[![pypi package](https://img.shields.io/pypi/v/lookml_visualizer.svg)](https://pypi.org/project/lookml_visualizer/)

**TL;DR** Visualize [LookML](https://docs.looker.com/data-modeling/learning-lookml/what-is-lookml) contents as an interactive Plotly figure.
**TL;DR** Visualize [LookML](https://docs.looker.com/data-modeling/learning-lookml/what-is-lookml) contents as a network diagram in an interactive Plotly figure.

Built on top of `lookml-tools`'s [grapher](https://github.com/ww-tech/lookml-tools/blob/master/lkmltools/grapher/lookml_grapher.py). Requires NetworkX and Plotly.
Built on top of `lookml-tools`'s [grapher](https://github.com/ww-tech/lookml-tools/blob/master/lkmltools/grapher/lookml_grapher.py). Requires NetworkX, graphviz, and Plotly.

### Getting Started

Expand Down Expand Up @@ -37,7 +37,7 @@ Example2: A large project
The network plot can have different layouts. The following example shows how to pass a different plot layout:

```python
network = PlotNetwork(paths, plot_layout='dfp')
network = PlotNetwork(paths, plot_layout='fdp')
```
which will display the same network in example 2 (above) in this layout:
![image](https://user-images.githubusercontent.com/3298308/103260846-2838b500-496d-11eb-9f01-ab15704983e6.png)
Expand Down
2 changes: 1 addition & 1 deletion lookml_visualizer/visualizer.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def build_color_map(grapher: LookMlGrapher, g: DiGraph) -> list[str]:

@staticmethod
def plotly_lookml(
G: DiGraph, color_map: List[str], plot_layout: str = "fdp"
G: DiGraph, color_map: list[str], plot_layout: str = "fdp"
) -> go.Figure:
"""Create an interactive plotly figure for the input `DiGraph` network
Expand Down

0 comments on commit 72c1667

Please sign in to comment.