https://github.com/jeshan/sceptre-dot

Visualise your sceptre projects with Graphviz
https://github.com/jeshan/sceptre-dot

graphviz graphviz-dot sceptre

Last synced: about 2 months ago
JSON representation

Visualise your sceptre projects with Graphviz

• Host: GitHub
• URL: https://github.com/jeshan/sceptre-dot
• Owner: jeshan
• License: bsd-2-clause
• Created: 2019-05-09T22:02:37.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-01T23:47:20.000Z (over 3 years ago)
• Last Synced: 2024-08-16T06:08:15.570Z (5 months ago)
• Topics: graphviz, graphviz-dot, sceptre
• Language: Python
• Size: 74.2 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![PyPI version](https://badge.fury.io/py/sceptre-dot.svg)](https://badge.fury.io/py/sceptre-dot)

![Build badge](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiNituTVJqN2UxSGJ6N2Y3UTdOODhuNCtEcE1Zc0Jjbm5QYlhHWEtPekZYS2VnTFdJU2ZoZUhSdkRNL2V2SWhHbCtwb01SNzVtV1ZUSTJtV0xta2NSNGRVPSIsIml2UGFyYW1ldGVyU3BlYyI6IjNZdlQzSXpqUE9uVDJYbWwiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)

Helps you visualise your Sceptre projects with Graphviz (DOT). Get started by running `pip install sceptre-dot`

![screenshot.png](screenshot.png)

# Benefits

- Visualisation can be added as a documentation artefact to your project

- Having many explicit/implicit dependencies can slow down deployments. Use the generated dependency graph to quickly spot bottlenecks due to these dependencies. 

# Installation

Install graphviz for your operating system as per [official instuctions](https://graphviz.gitlab.io/download/).

Install this package in the same python interpreter (virtualenv) that Sceptre is installed so that its python library is already available:

`pip install sceptre-dot`

# Usage

In the same directory where you would normally invoke `sceptre launch -y $YOUR_PATH`, run: 

```bash

sceptre-dot $YOUR_PATH > output.dot

fdp -Tpng output.dot -o output.png # use fdp engine for best results

```

If you can't or don't want to install graphviz, you can paste the outputted dot file in an online viewer like [viz-js](http://viz-js.com/). (Be sure to choose the **fdp** engine) 

Released under the Simplified BSD Licence.