compose-viz

No description

Find a file

Xyphuz 02fda82cf6 Merge pull request #9 from compose-viz/dev-parser chore: implement service_ewtends parse		2022-05-21 15:24:10 +08:00
.github/workflows	feat: show pytest coverage in ci	2022-05-19 15:29:37 +08:00
compose_viz	chore: implement service_ewtends parse	2022-05-21 14:35:03 +08:00
tests	test: add test_module.py	2022-05-19 16:06:16 +08:00
.gitignore	chore: apply pre-commit hooks	2022-05-18 23:28:18 +08:00
.pre-commit-config.yaml	test: parser exceptions	2022-05-19 00:34:26 +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	fix: missing dev dependency	2022-05-19 15:37:49 +08:00
README.md	chore: update README.md	2022-05-15 19:24:36 +08:00

README.md

Explore Usage »

Report Bug · Request Feature

Table of Contents

About The Project
Getting Started
- Installation
- Usage
- Options
- Example
Roadmap
Contributing
License
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

Installation

Using `pip`

pip install compose-viz

Using `.whl`

See releases.

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.

Example

cpv -o docker-compose-viz.png docker-compose.yml

(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!