Explore Usage »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisities
   • Installation
   • Example
   • Usage
   • Options
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

compose-viz is a compose file visualization tool that follows compose-spec and allows you to gernerate graph in several formats.

If you are looking for a compose file vizualization tool, and you are using one of the compose-spec implementations (e.g. docker-compose/podman-compose), then compose-viz is a great choice for you.

(back to top)

Getting Started

Prerequisities

Graphviz

You need to install Graphviz to generate graphs.

Installation

Using pip

pip install compose-viz

Using .whl

See releases.

Docker Image

See wst24365888/compose-viz.

Example

This example yml is from docker compose beginner tutorial.

cd examples/voting-app/

# using python script
cpv -m svg docker-compose.yml

# using docker image
docker run --rm -it -v $(pwd):/in wst24365888/compose-viz -m svg docker-compose.yml

# using docker image in powershell
docker run --rm -it -v ${pwd}:/in wst24365888/compose-viz -m svg docker-compose.yml

And this is what the result looks like:

Check out the result here.

Usage

cpv [OPTIONS] INPUT_PATH

Options

Option	Description
-o, --output-filename FILENAME	Output filename for the generated visualization file. [default: compose-viz]
-m, --format FORMAT	Output format for the generated visualization file. See supported formats. [default: png]
-r, --root-service SERVICE_NAME	Root of the service tree (convenient for large compose yamls)
-l, --legend	Include a legend in the visualization.
-p, --no-ports	Don't show ports.
-s, --simple	Output a more simple graph with no image names and only basename of sources.
-v, --version	Show the version of compose-viz.
--help	Show help and exit.

(back to top)

Roadmap

• Support more vizualization components.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature)
3. Commit your Changes with Conventional Commits
4. Push to the Branch (git push origin feat/amazing-feature)
5. Open a Pull Request, please select the dev branch as the target branch.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Author

• HSING-HAN, WU (Xyphuz)
  • Mail me: xyphuzwu@gmail.com
  • About me: https://www.xyphuz.com
  • GitHub: https://github.com/wst24365888

Project Link

• https://github.com/compose-viz/compose-viz

(back to top)