compose-viz

No description

Find a file

Xyphuz 2570ea42ce Merge pull request #17 from compose-viz/dev chore: fix typo in README.md		2022-05-26 02:01:58 +08:00
.github/workflows	chore: add new examples	2022-05-25 17:46:53 +08:00
compose_viz	chore: implement new image parsing rule	2022-05-25 17:47:23 +08:00
examples	chore: add new example	2022-05-25 21:51:56 +08:00
tests	chore: add new examples	2022-05-25 17:46:53 +08:00
.gitignore	chore: add cpv results in examples	2022-05-25 17:55:52 +08:00
.pre-commit-config.yaml	chore: apply pre-commit hooks	2022-05-25 17:16:10 +08:00
LICENSE	chore: add LICENSE	2022-05-02 16:17:17 +08:00
poetry.lock	fix: missing dev dependency	2022-05-19 15:37:49 +08:00
pyproject.toml	chore: update pyproject description	2022-05-25 21:29:01 +08:00
README.md	chore: fix typo in README.md	2022-05-26 02:01:36 +08:00

README.md

Explore Usage »

Report Bug · Request Feature

Table of Contents

About The Project
Getting Started
- Prerequisities
- Installation
- Example
- Usage
- Options
Roadmap
Contributing
License
Contact

About The Project

compose-viz is a compose file visualization tool that supports compose-spec and allows you to gernerate graph in DOT format or .png.

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

If you want to generate PNG (which is the default option), you need to install Graphviz.

Installation

Using `pip`

pip install compose-viz

Using `.whl`

See releases.

Example

cpv -o .\examples\full-stack-node-app\compose-viz.png .\examples\full-stack-node-app\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-path`	Output path for the generated visualization file. [default: ./compose-viz.png]
`-m, --format [PNG,DOT]`	Output format for the generated visualization file. [default: PNG]
`-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!