{"id":13415871,"url":"https://github.com/funkwerk/compose_plantuml","last_synced_at":"2025-08-21T18:33:17.771Z","repository":{"id":43022359,"uuid":"54227280","full_name":"funkwerk/compose_plantuml","owner":"funkwerk","description":"Generate Plantuml graphs from docker-compose files","archived":false,"fork":false,"pushed_at":"2022-03-22T20:47:51.000Z","size":33,"stargazers_count":90,"open_issues_count":3,"forks_count":8,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-09-18T20:30:05.340Z","etag":null,"topics":["compose","docker","docker-compose","model","plantuml"],"latest_commit_sha":null,"homepage":null,"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/funkwerk.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}},"created_at":"2016-03-18T19:43:09.000Z","updated_at":"2024-07-01T21:30:38.000Z","dependencies_parsed_at":"2022-09-10T16:00:21.494Z","dependency_job_id":null,"html_url":"https://github.com/funkwerk/compose_plantuml","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkwerk%2Fcompose_plantuml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkwerk%2Fcompose_plantuml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkwerk%2Fcompose_plantuml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkwerk%2Fcompose_plantuml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/funkwerk","download_url":"https://codeload.github.com/funkwerk/compose_plantuml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230527866,"owners_count":18240051,"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","docker","docker-compose","model","plantuml"],"created_at":"2024-07-30T21:00:52.683Z","updated_at":"2024-12-20T03:09:32.393Z","avatar_url":"https://github.com/funkwerk.png","language":"Python","funding_links":[],"categories":["Container Operations","docker"],"sub_categories":["Container Composition"],"readme":"[![Build Status](https://travis-ci.org/funkwerk/compose_plantuml.svg)](https://travis-ci.org/funkwerk/compose_plantuml)\n[![](https://badge.imagelayers.io/funkwerk/compose_plantuml.svg)](https://imagelayers.io/?images=funkwerk/compose_plantuml:latest 'funkwerk/compose_plantuml')\n[![PyPi downloads](https://img.shields.io/pypi/dm/compose_plantuml.svg)](https://pypi.python.org/pypi/compose_plantuml/)\n[![PyPi version](https://img.shields.io/pypi/v/compose_plantuml.svg)](https://pypi.python.org/pypi/compose_plantuml/)\n[![Docker pulls](https://img.shields.io/docker/pulls/funkwerk/compose_plantuml.svg)](https://hub.docker.com/r/funkwerk/compose_plantuml/)\n\n# compose_plantuml\n\nGenerate Plantuml graphs from docker-compose files\n\nNote that version 2 as well as the legacy version is supported.\n\n## Usage\n\n### Via Python\n\nInstall it via:\n`pip3 install compose_plantuml`\n\nAfter that use it like:\n`compose_plantuml --link-graph docker-compose.yml`\n\n### Via Docker\n\nUse it like:\n`cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --link-graph`\n\nFor SVG Output, just call:\n\n`cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --link-graph | docker run -i think/plantuml \u003e output.svg`\n\nFor PNG Output, just call:\n\n`cat docker-compose.yml | docker run -i funkwerk/compose_plantuml --link-graph | docker run -i think/plantuml -tpng \u003e output.png`\n\n## Link Graph\n\nLink Graphs provide an overview over docker-compose services.\n\nConsider the following docker-compose.yml\n\n```\nversion: '2'\nservices:\n  first:\n    links:\n      - second\n  second: {}\n```\n\nWhen calling 'compose_plantuml docker-compose.yml' it will generate the following link graph:\n\n```\n[first]\n[second]\n[first] --\u003e [second]\n```\n\nRendered it looks like:\n\n\u003cimg src=\"https://cdn.rawgit.com/funkwerk/compose_plantuml/master/img/link_graph.svg\"\u003e\n\n## Boundaries\n\nBoundaries visualize the external boundaries a system has.\n\nConsider the following docker-compose.yml\n\n```\nversion: '2'\nservices:\n  service:\n    ports:\n      - 8080:80\n```\n\nWhen calling 'compose_plantuml --boundaries docker-compose.yml' it will generate the following plantuml:\n\n```\nrectangle system {\n  [service]\n}\n[service] --\u003e 8080 : 80\n```\n\nRendered it looks like:\n\n\u003cimg src=\"https://cdn.rawgit.com/funkwerk/compose_plantuml/master/img/boundaries.svg\"\u003e\n\n## Related Links\n\n - draw compose\n   - https://github.com/Alexis-benoist/draw-compose\n   - generates dot graphs from docker-compose files\n   - currently just supports docker-compose version 1\n   - does not read from stdin, so is not easy useable as docker container\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunkwerk%2Fcompose_plantuml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffunkwerk%2Fcompose_plantuml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunkwerk%2Fcompose_plantuml/lists"}