https://github.com/Alexis-benoist/draw-compose

Render Docker compose files.
https://github.com/Alexis-benoist/draw-compose

Last synced: about 2 months ago
JSON representation

Render Docker compose files.

• Host: GitHub
• URL: https://github.com/Alexis-benoist/draw-compose
• Owner: Alexis-benoist
• License: mit
• Created: 2015-12-27T22:31:24.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T19:56:58.000Z (almost 2 years ago)
• Last Synced: 2024-09-13T05:57:35.226Z (3 months ago)
• Language: Python
• Size: 46.9 KB
• Stars: 90
• Watchers: 6
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-docker - draw-compose - Utility to draw a schema of a docker compose by [@Alexis-benoist](https://github.com/Alexis-benoist) (Container Operations / Container Composition)
• awesome-docker - draw-compose - Utility to draw a schema of a docker compose by [@Alexis-benoist](https://github.com/Alexis-benoist) (Container Operations / Container Composition)

README

        
# Draw compose

Render compose files with one command line!

This project needs graphviz installed.

## Simple example

![Simple example](https://raw.githubusercontent.com/Alexis-benoist/draw-compose/master/fixtures/simple.png?raw=true "Simple Example")

## Classic python example

![Python classic](https://raw.githubusercontent.com/Alexis-benoist/draw-compose/master/fixtures/real.png?raw=true "Python web app")

# Install

## On OSX:

Install graphviz `brew install graphviz` and draw-compose:

    $ pip install draw-compose

# Use

Renders by default `docker-compose.yml` in the current folder.

    $ draw-compose -o docker.png

Or a specific docker file can be rendered:

    $ draw-compose -i fixtures/real.yml -o docker-specific.png

# Notes

Released under an Apache License 2.0

Similar:

 - [docker-compose-graphviz](https://github.com/abesto/docker-compose-graphviz) written in GoLang

 - [compose-plantuml](https://github.com/funkwerk/compose_plantuml) written in Python

Creator: Alexis Benoist @Alexis_Benoist

Inspired by [ERAlchemy](https://github.com/Alexis-benoist/ERAlchemy)