compose-viz/README.md

Explore Usage »

Report Bug · Request Feature

Table of Contents

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

About The Project

compose-viz is a docker-compose/podman-compose graph visualization tool that allows you to gernerate graph in DOT format or .png.

(back to top)

Getting Started

Usage

python3 compose-viz.py [OPTIONS] [input-file]

Options

Option	Necessity	Description	Default Value
-o --output-file	Optional	Output file path.	./compose.png
-m --output-format=DOT, PNG	Optional	Output format.	PNG

Example

python3 compose-viz.py docker-compose.yaml

(back to top)

Roadmap

• Support podman-compose.

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

(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://about.xyphuz.com
  • GitHub: https://github.com/wst24365888

Project Link

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

(back to top)