{"id":17342555,"url":"https://github.com/compose-viz/compose-viz","last_synced_at":"2025-04-05T14:03:41.054Z","repository":{"id":38198717,"uuid":"487752364","full_name":"compose-viz/compose-viz","owner":"compose-viz","description":"A compose file visualization tool that follows compose-spec and allows you to gernerate graph in several formats.","archived":false,"fork":false,"pushed_at":"2025-03-29T01:19:20.000Z","size":1190,"stargazers_count":60,"open_issues_count":110,"forks_count":10,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T13:09:28.194Z","etag":null,"topics":["compose","compose-files","compose-spec","compose-viz","containers","docker","docker-compose","graphviz","graphviz-dot","podmain-compose","podman","vizualization"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/compose-viz/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/compose-viz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-02T07:20:51.000Z","updated_at":"2025-03-19T07:54:41.000Z","dependencies_parsed_at":"2024-12-22T12:14:53.588Z","dependency_job_id":"50efe242-8a1c-4da0-a29b-49de24084ecf","html_url":"https://github.com/compose-viz/compose-viz","commit_stats":{"total_commits":216,"total_committers":11,"mean_commits":"19.636363636363637","dds":"0.31481481481481477","last_synced_commit":"f522fc630c98ca48563759d52fe2fbf23a4a0977"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compose-viz%2Fcompose-viz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compose-viz%2Fcompose-viz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compose-viz%2Fcompose-viz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compose-viz%2Fcompose-viz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compose-viz","download_url":"https://codeload.github.com/compose-viz/compose-viz/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247345850,"owners_count":20924102,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compose","compose-files","compose-spec","compose-viz","containers","docker","docker-compose","graphviz","graphviz-dot","podmain-compose","podman","vizualization"],"created_at":"2024-10-15T16:06:13.238Z","updated_at":"2025-04-05T14:03:41.035Z","avatar_url":"https://github.com/compose-viz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\n[\u003cdiv align=\"center\"\u003e ![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![MIT License][license-shield]][license-url]\n[![Issues][issues-shield]][issues-url]\n[![Issues Closed][issues-closed-shield]\u003c/div\u003e][issues-closed-url]\n\n\u003cbr /\u003e\n\n\u003c!-- PROJECT LOGO --\u003e\n\n![compose-viz](https://socialify.git.ci/compose-viz/compose-viz/image?description=1\u0026font=KoHo\u0026name=1\u0026owner=1\u0026pattern=Circuit%20Board\u0026theme=Light)\n\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/compose-viz/compose-viz#usage\"\u003e\u003cstrong\u003eExplore Usage »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/compose-viz/compose-viz/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/compose-viz/compose-viz/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisities\"\u003ePrerequisities\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#example\"\u003eExample\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#options\"\u003eOptions\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n`compose-viz` is a compose file visualization tool that follows [compose-spec](https://github.com/compose-spec/compose-spec/blob/master/spec.md) and allows you to gernerate graph in several formats.\n\nIf you are looking for a compose file vizualization tool, and you are using one of the [compose-spec](https://github.com/compose-spec/compose-spec/blob/master/spec.md) implementations (e.g. [docker-compose](https://github.com/docker/compose)/[podman-compose](https://github.com/containers/podman-compose)), then `compose-viz` is a great choice for you. \n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\n### Prerequisities\n\n#### Graphviz\n\nYou need to install [Graphviz](https://graphviz.org/download/) to generate graphs.\n\n### Installation\n\n#### Using `pip`\n\n```\npip install compose-viz\n```\n\n#### Using `.whl`\n\nSee [releases](https://github.com/compose-viz/compose-viz/releases).\n\n#### Docker Image\n\nSee [wst24365888/compose-viz](https://hub.docker.com/r/wst24365888/compose-viz/tags).\n\n### Example\n\nThis example yml is from [docker compose beginner tutorial](https://github.com/docker/labs/blob/master/beginner/chapters/votingapp.md).\n\n```bash\ncd examples/voting-app/\n\n# using python script\ncpv -m svg docker-compose.yml\n\n# using docker image\ndocker run --rm -it -v $(pwd):/in wst24365888/compose-viz -m svg docker-compose.yml\n\n# using docker image in powershell\ndocker run --rm -it -v ${pwd}:/in wst24365888/compose-viz -m svg docker-compose.yml\n```\n\nAnd this is what the result looks like:\n\n![compose-viz.svg](https://github.com/compose-viz/compose-viz/blob/main/examples/voting-app/compose-viz.svg)\n\nCheck out the result [here](https://github.com/compose-viz/compose-viz/blob/main/examples/voting-app).\n\n### Usage\n\n`cpv [OPTIONS] INPUT_PATH`\n\n### Options\n\n| Option                            | Description                                                                                                                                                                         |\n| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `-o, --output-filename FILENAME`  | Output filename for the generated visualization file. [default: compose-viz]                                                                                                        |\n| `-m, --format FORMAT`             | Output format for the generated visualization file. See [supported formats](https://github.com/compose-viz/compose-viz/blob/main/compose_viz/models/viz_formats.py). [default: png] |\n| `-r, --root-service SERVICE_NAME` | Root of the service tree (convenient for large compose yamls)                                                                                                                       |\n| `-l, --legend`                    | Include a legend in the visualization.                                                                                                                                              |\n| `-p, --no-ports`                  | Don't show ports.                                                                                                                                                                   |\n| `-s, --simple`                    | Output a more simple graph with no image names and only basename of sources.                                                                                                        |\n| `-v, --version`                   | Show the version of compose-viz.                                                                                                                                                    |\n| `--help`                          | Show help and exit.                                                                                                                                                                 |\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\n- [ ] Support more vizualization components.\n\nSee the [open issues](https://github.com/compose-viz/compose-viz/issues)\nfor a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to\nlearn, inspire, and create. Any contributions you make are **greatly\nappreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and\ncreate a pull request. You can also simply open an issue with the tag\n\"enhancement\". Don't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feat/amazing-feature`)\n3. Commit your Changes with\n   [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)\n4. Push to the Branch (`git push origin feat/amazing-feature`)\n5. Open a Pull Request, **please select the `dev` branch as the target\n   branch**.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the MIT License. See\n[LICENSE](https://github.com/compose-viz/compose-viz/blob/main/LICENSE)\nfor more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n\n## Contact\n\n### Author\n\n- HSING-HAN, WU (Xyphuz)\n  - Mail me: xyphuzwu@gmail.com\n  - About me: \u003chttps://www.xyphuz.com\u003e\n  - GitHub: \u003chttps://github.com/wst24365888\u003e\n\n### Project Link\n\n- \u003chttps://github.com/compose-viz/compose-viz\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/compose-viz/compose-viz.svg?style=for-the-badge\n[contributors-url]: https://github.com/compose-viz/compose-viz/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/compose-viz/compose-viz.svg?style=for-the-badge\n[forks-url]: https://github.com/compose-viz/compose-viz/network/members\n[stars-shield]: https://img.shields.io/github/stars/compose-viz/compose-viz.svg?style=for-the-badge\n[stars-url]: https://github.com/compose-viz/compose-viz/stargazers\n[issues-shield]: https://img.shields.io/github/issues/compose-viz/compose-viz.svg?style=for-the-badge\n[issues-url]: https://github.com/compose-viz/compose-viz/issues\n[issues-closed-shield]: https://img.shields.io/github/issues-closed/compose-viz/compose-viz.svg?style=for-the-badge\n[issues-closed-url]: https://github.com/compose-viz/compose-viz/issues?q=is%3Aissue+is%3Aclosed\n[license-shield]: https://img.shields.io/github/license/compose-viz/compose-viz.svg?style=for-the-badge\n[license-url]: https://github.com/compose-viz/compose-viz/blob/main/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompose-viz%2Fcompose-viz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompose-viz%2Fcompose-viz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompose-viz%2Fcompose-viz/lists"}