# Logo Diagram Generator 🎨
[](https://pypi.org/project/logo-diagram-generator/)
[](https://github.com/beveradb/logo-diagram-generator/blob/main/LICENSE)
[](https://hub.docker.com/r/beveradb/logo-diagram-generator)
[](https://hub.docker.com/r/beveradb/logo-diagram-generator)
This package, `logo-diagram-generator`, allows you to generate SVG diagrams that visually represent a technology ecosystem, including tool logos, based on a YAML configuration file. It's designed to help visualize the relationships and categories of tools within a technology stack, making it easier to understand at a glance.
## Example Output
Here's an example of a diagram generated using `logo-diagram-generator`
This is the command used to render it, using one of the example configurations:
```bash
docker run -it -v `pwd`:/app beveradb/logo-diagram-generator -c examples/full.example.yml -o examples -n full.example
```
## Quick Start
1. **Install the Package**
Ensure you have Python and pip installed on your system. Install `logo-diagram-generator` from PyPI:
```bash
pip install logo-diagram-generator
```
**🐳 Alternately, use Docker and skip to step 3! 🎉**
```bash
docker run -it -v `pwd`:/app beveradb/logo-diagram-generator
```
If you use Docker, you don't need to install anything on your system as the tool runs in a container.
2. **Install Graphviz**
This tool uses [Graphviz](https://graphviz.org/) to render the graph, so you need the graphviz binaries installed on your system for this to work.
Depending whether you're installing in a conda environment, or directly on your Mac or Linux system, one of these commands should be what you need:
- conda install graphviz
- brew install graphviz
- sudo apt-get install graphviz
3. **Prepare Your Configuration**
Create a `config.yml` file for your own diagram by copying one of the provided examples. `examples/minimal.example.yml` is a simple one to start with.
Edit your config file to list all the tools in your ecosystem, with category groupings as you see fit. The minimum viable config would be one central tool and one group:
```yaml
ecosystem:
centralTool:
name: Kubernetes
groups:
- category: Cluster Management
tools:
- name: Rancher
```
See `examples/full.example.yml` for more configuration examples - these become more relevant when you need to tweak the styles or layout of the diagram after your first run.
4. **Download Logos and Generate Diagram**
With your configuration ready, run the `logo-diagram-generator` CLI in the same directory as your `config.yml` file, and it will download logos (with interactive input if it isn't able to find one on the first try) and generate your ecosystem diagram:
```bash
logo-diagram-generator
```
This will download the necessary logos and produce an SVG file named `diagram_logos.svg` in your current directory.
For further customization options for paths and output names, use `--help` to see all available CLI parameters:
```bash
usage: logo-diagram-generator [-h] [-d] [--log_level LOG_LEVEL] [-n NAME] [-c CONFIG] [-l LOGOS_DIR] [-s SKIP_DOWNLOAD] [-o OUTPUT_DIR]
Generate SVG diagrams of a tech ecosystem, using logos from each tool organised into groups around a central logo.
options:
-h, --help show this help message and exit
-d, --debug enable debug logging, equivalent to --log_level=debug
--log_level LOG_LEVEL log level, e.g. info, debug, warning (default: info)
-n NAME, --name NAME Base name for the output SVG files.
-c CONFIG, --config CONFIG Path to the configuration file.
-l LOGOS_DIR, --logos_dir LOGOS_DIR Directory where logos are stored.
-s SKIP_DOWNLOAD, --skip_download SKIP_DOWNLOAD Skip downloading logos before generating.
-o OUTPUT_DIR, --output_dir OUTPUT_DIR Directory for the output SVG diagram.
```
## Customizing Your Diagram
- **Configuration File**: Modify `config.yml` to add, remove, or categorize tools as needed. Each tool can have a `name`, `label`, and optionally an `alias` or `svgURL` for custom logo URLs.
- **Logo Download**: If the automatic logo download doesn't find a logo for a tool, you can specify the URL interactively or manually place an SVG file in the `logos` directory. The file name should match the tool's name in the configuration file, in lowercase.
- **Diagram Appearance**: The appearance of the generated diagram can be customized by modifying the `config.yml` file. See the example configs and Graphviz documentation for more info.
### Overriding Config
You can override config entries in the config file from the command-line, using the `--override` parameter.
This is particularly useful if you have a diagram which you want to keep mostly the same but generate multiple slightly different versions of, e.g. a dark themed version:
```bash
logo-diagram-generator -c examples/full.example.yml -o examples -n full.example.dark --override 'style.diagramBackgroundColor=#333333' --override 'style.groupLabelFontcolor=#ffffff' --override 'style.colorPalette=aqua,purple3,maroon3,orangered,yellow,lime,fuchsia,#6495ed,peachpuff,forestgreen'
```
### Dark / Light Theme
A common challenge when generating these diagrams is making them work on different background colors.
To help with this, as well as the `--override` parameter above, there is also a convenient `--theme` CLI parameter.
There are two options, `dark` and `light`, which set the group label text color and line color palette, and add either a white or dark grey stroke around every path in every logo, to help those logos be visible on a light or dark background. Examples below:
```bash
logo-diagram-generator -c examples/full.example.yml -o examples -n full.example.dark --override 'style.diagramBackgroundColor=#111111' --theme dark
```
```bash
logo-diagram-generator -c examples/full.example.yml -o examples -n full.example.light --theme light
```
**⚠️ Warning: ** This approach is not perfect - adding a stroke around paths in the logo SVGs sometimes makes them look awful or totally breaks them!
If you find a specific logo doesn't work with this, you can set `strokeWidth: 0` on that tool in the config to disable the stroke for it.
## Contributing
Contributions to improve `logo-diagram-generator` or add new features are welcome. Please submit a pull request or open an issue to discuss your ideas.
Raw data
{
"_id": null,
"home_page": "https://github.com/beveradb/logo-diagram-generator",
"name": "logo-diagram-generator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "devops,diagram,diagram-generator,svg,vector-graphics",
"author": "Andrew Beveridge",
"author_email": "andrew@beveridge.uk",
"download_url": "https://files.pythonhosted.org/packages/d2/19/b62d3d9146eab04a32513eeaab16a56f1177eade38bf196a521329590e70/logo_diagram_generator-0.3.3.tar.gz",
"platform": null,
"description": "# Logo Diagram Generator \ud83c\udfa8\n\n[](https://pypi.org/project/logo-diagram-generator/)\n[](https://github.com/beveradb/logo-diagram-generator/blob/main/LICENSE)\n[](https://hub.docker.com/r/beveradb/logo-diagram-generator)\n[](https://hub.docker.com/r/beveradb/logo-diagram-generator)\n\nThis package, `logo-diagram-generator`, allows you to generate SVG diagrams that visually represent a technology ecosystem, including tool logos, based on a YAML configuration file. It's designed to help visualize the relationships and categories of tools within a technology stack, making it easier to understand at a glance.\n\n## Example Output\n\nHere's an example of a diagram generated using `logo-diagram-generator`\n\nThis is the command used to render it, using one of the example configurations:\n```bash\ndocker run -it -v `pwd`:/app beveradb/logo-diagram-generator -c examples/full.example.yml -o examples -n full.example\n```\n\n\n\n## Quick Start\n\n1. **Install the Package**\n\n Ensure you have Python and pip installed on your system. Install `logo-diagram-generator` from PyPI:\n\n ```bash\n pip install logo-diagram-generator\n ```\n\n **\ud83d\udc33 Alternately, use Docker and skip to step 3! \ud83c\udf89**\n ```bash\n docker run -it -v `pwd`:/app beveradb/logo-diagram-generator\n ```\n If you use Docker, you don't need to install anything on your system as the tool runs in a container.\n\n2. **Install Graphviz**\n\n This tool uses [Graphviz](https://graphviz.org/) to render the graph, so you need the graphviz binaries installed on your system for this to work.\n\n Depending whether you're installing in a conda environment, or directly on your Mac or Linux system, one of these commands should be what you need:\n\n - conda install graphviz\n - brew install graphviz\n - sudo apt-get install graphviz\n\n3. **Prepare Your Configuration**\n\n Create a `config.yml` file for your own diagram by copying one of the provided examples. `examples/minimal.example.yml` is a simple one to start with.\n \n Edit your config file to list all the tools in your ecosystem, with category groupings as you see fit. The minimum viable config would be one central tool and one group:\n\n ```yaml\n ecosystem:\n centralTool:\n name: Kubernetes\n groups:\n - category: Cluster Management\n tools:\n - name: Rancher\n ```\n\n See `examples/full.example.yml` for more configuration examples - these become more relevant when you need to tweak the styles or layout of the diagram after your first run.\n\n4. **Download Logos and Generate Diagram**\n\n With your configuration ready, run the `logo-diagram-generator` CLI in the same directory as your `config.yml` file, and it will download logos (with interactive input if it isn't able to find one on the first try) and generate your ecosystem diagram:\n\n ```bash\n logo-diagram-generator\n ```\n\n This will download the necessary logos and produce an SVG file named `diagram_logos.svg` in your current directory.\n\n For further customization options for paths and output names, use `--help` to see all available CLI parameters:\n\n ```bash\n usage: logo-diagram-generator [-h] [-d] [--log_level LOG_LEVEL] [-n NAME] [-c CONFIG] [-l LOGOS_DIR] [-s SKIP_DOWNLOAD] [-o OUTPUT_DIR]\n\n Generate SVG diagrams of a tech ecosystem, using logos from each tool organised into groups around a central logo.\n\n options:\n -h, --help show this help message and exit\n -d, --debug enable debug logging, equivalent to --log_level=debug\n --log_level LOG_LEVEL log level, e.g. info, debug, warning (default: info)\n -n NAME, --name NAME Base name for the output SVG files.\n -c CONFIG, --config CONFIG Path to the configuration file.\n -l LOGOS_DIR, --logos_dir LOGOS_DIR Directory where logos are stored.\n -s SKIP_DOWNLOAD, --skip_download SKIP_DOWNLOAD Skip downloading logos before generating.\n -o OUTPUT_DIR, --output_dir OUTPUT_DIR Directory for the output SVG diagram.\n ```\n\n## Customizing Your Diagram\n\n- **Configuration File**: Modify `config.yml` to add, remove, or categorize tools as needed. Each tool can have a `name`, `label`, and optionally an `alias` or `svgURL` for custom logo URLs.\n- **Logo Download**: If the automatic logo download doesn't find a logo for a tool, you can specify the URL interactively or manually place an SVG file in the `logos` directory. The file name should match the tool's name in the configuration file, in lowercase.\n- **Diagram Appearance**: The appearance of the generated diagram can be customized by modifying the `config.yml` file. See the example configs and Graphviz documentation for more info.\n\n### Overriding Config\n\nYou can override config entries in the config file from the command-line, using the `--override` parameter.\n\nThis is particularly useful if you have a diagram which you want to keep mostly the same but generate multiple slightly different versions of, e.g. a dark themed version:\n\n```bash\nlogo-diagram-generator -c examples/full.example.yml -o examples -n full.example.dark --override 'style.diagramBackgroundColor=#333333' --override 'style.groupLabelFontcolor=#ffffff' --override 'style.colorPalette=aqua,purple3,maroon3,orangered,yellow,lime,fuchsia,#6495ed,peachpuff,forestgreen'\n```\n\n### Dark / Light Theme\n\nA common challenge when generating these diagrams is making them work on different background colors.\n\nTo help with this, as well as the `--override` parameter above, there is also a convenient `--theme` CLI parameter.\n\nThere are two options, `dark` and `light`, which set the group label text color and line color palette, and add either a white or dark grey stroke around every path in every logo, to help those logos be visible on a light or dark background. Examples below:\n\n```bash\nlogo-diagram-generator -c examples/full.example.yml -o examples -n full.example.dark --override 'style.diagramBackgroundColor=#111111' --theme dark\n```\n\n\n```bash\nlogo-diagram-generator -c examples/full.example.yml -o examples -n full.example.light --theme light\n```\n\n\n**\u26a0\ufe0f Warning: ** This approach is not perfect - adding a stroke around paths in the logo SVGs sometimes makes them look awful or totally breaks them! \n\nIf you find a specific logo doesn't work with this, you can set `strokeWidth: 0` on that tool in the config to disable the stroke for it.\n\n\n## Contributing\n\nContributions to improve `logo-diagram-generator` or add new features are welcome. Please submit a pull request or open an issue to discuss your ideas.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generate SVG diagrams of a (tech) ecosystem, using logos from each tool organised into groups around a central logo",
"version": "0.3.3",
"project_urls": {
"Documentation": "https://github.com/beveradb/logo-diagram-generator/blob/main/README.md",
"Homepage": "https://github.com/beveradb/logo-diagram-generator",
"Repository": "https://github.com/beveradb/logo-diagram-generator"
},
"split_keywords": [
"devops",
"diagram",
"diagram-generator",
"svg",
"vector-graphics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2a7e6612908320628892224015b8648eef3d626f2a2b5d6b4c0dad195e77882",
"md5": "26ce50db181929e845a211eb4d0c1bc6",
"sha256": "f633d5588c110c6af8b4a220def9c9ff8fca4e36e98baed2ae1c67fdccc86e5c"
},
"downloads": -1,
"filename": "logo_diagram_generator-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26ce50db181929e845a211eb4d0c1bc6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14507,
"upload_time": "2024-03-08T00:07:30",
"upload_time_iso_8601": "2024-03-08T00:07:30.164676Z",
"url": "https://files.pythonhosted.org/packages/b2/a7/e6612908320628892224015b8648eef3d626f2a2b5d6b4c0dad195e77882/logo_diagram_generator-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d219b62d3d9146eab04a32513eeaab16a56f1177eade38bf196a521329590e70",
"md5": "1c9ccc3521a89f25951d2d31a41e1f64",
"sha256": "0ba899fd7305e3b62e7fdb378f076cc6052e22c6f6e75df531b027587cf2489a"
},
"downloads": -1,
"filename": "logo_diagram_generator-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "1c9ccc3521a89f25951d2d31a41e1f64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14554,
"upload_time": "2024-03-08T00:07:31",
"upload_time_iso_8601": "2024-03-08T00:07:31.948218Z",
"url": "https://files.pythonhosted.org/packages/d2/19/b62d3d9146eab04a32513eeaab16a56f1177eade38bf196a521329590e70/logo_diagram_generator-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 00:07:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "beveradb",
"github_project": "logo-diagram-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "logo-diagram-generator"
}
JSON
