Generate DrawIO shape libraries from SVGs
Project description
SVG2DrawIOLib
Convert SVG files into DrawIO/diagrams.net shape libraries with support for colorable icons.
Features
- ✨ Batch Conversion: Process individual files, entire directories, or recursive folder structures
- 🎯 Pixel-Perfect Rendering: Browser-accurate bounding box calculation (via
svgelements) eliminates padding and ensures icons render exactly as designed - 🎨 Color Customization: Inject CSS classes to enable color editing directly in DrawIO's interface
- 📏 Flexible Sizing: Proportional scaling with aspect ratio preservation, or fixed dimensions
- 📚 Library Management: Create new libraries, add/remove icons, and list contents
- 🚀 Modern CLI: Beautiful, colorful output with rich-click
- 🔧 Modern Python Stack: Built with ruff, mypy, bandit, pytest, and pre-commit hooks
Quick Start
Installation
pip install SVG2DrawIOLib
or
uv pip install SVG2DrawIOLib
Basic Usage
# Convert individual SVG files to DrawIO library
SVG2DrawIOLib create icon1.svg icon2.svg -o my-library.xml
# Convert all SVGs in a directory
SVG2DrawIOLib create icons/ -o my-library.xml
# Convert all SVGs in directory and subdirectories
SVG2DrawIOLib create icons/ -o my-library.xml --recursive
# Enable color editing in DrawIO
SVG2DrawIOLib create icons/ --css -o colorable-icons.xml
# Custom dimensions with proportional scaling
SVG2DrawIOLib create icons/ --max-size 64 -o large-icons.xml -R
Documentation
- Quick Start Guide - Get started quickly for users and developers
- Architecture - Technical details and implementation
- Contributing Guide - Development workflow
- Changelog - Version history
Commands
Library Management Commands
Create a Library
Create a new DrawIO library from SVG files:
# Basic usage
SVG2DrawIOLib create icon1.svg icon2.svg -o my-library.xml
# From directory
SVG2DrawIOLib create icons/ -o my-library.xml
# Recursive directory scan
SVG2DrawIOLib create icons/ -o my-library.xml --recursive
# Split by folder (creates separate libraries per subdirectory)
SVG2DrawIOLib create icons/ -o FontAwesome.xml -R --split-by-folder
# Creates: FontAwesome-Regular.xml, FontAwesome-Solid.xml, etc.
Add Icons to Library
Add new icons to an existing library:
# Add single icon
SVG2DrawIOLib add my-library.xml new-icon.svg
# Add multiple icons
SVG2DrawIOLib add my-library.xml icon1.svg icon2.svg
# Replace duplicates
SVG2DrawIOLib add my-library.xml icon.svg --replace
Remove Icons
Remove icons from a library by name:
SVG2DrawIOLib remove my-library.xml icon-name1 icon-name2
Extract Icons
Extract icons from a library back to individual SVG files:
# Extract all icons
SVG2DrawIOLib extract my-library.xml -o output-dir/
# Extract specific icons
SVG2DrawIOLib extract my-library.xml -o output-dir/ icon1 icon2
# Overwrite existing files
SVG2DrawIOLib extract my-library.xml -o output-dir/ --overwrite
Rename Icons
Rename an icon within a library:
# Rename icon
SVG2DrawIOLib rename my-library.xml -o old-name -n new-name
# Overwrite if new name exists
SVG2DrawIOLib rename my-library.xml -o old-name -n new-name --overwrite
Library Inspection Commands
List Icons
List all icons in a library:
SVG2DrawIOLib list my-library.xml
Inspect Icons
Display detailed information about icons:
# Inspect all icons
SVG2DrawIOLib inspect my-library.xml
# Inspect specific icons
SVG2DrawIOLib inspect my-library.xml icon1 icon2
# Show SVG content
SVG2DrawIOLib inspect my-library.xml --show-svg
# JSON output
SVG2DrawIOLib inspect my-library.xml --json
Validate Library
Validate library file integrity:
SVG2DrawIOLib validate my-library.xml
SVG Processing Commands
Split Compound Paths
Split SVG paths with multiple shapes into separate paths for per-path color control:
# Split compound paths in an SVG
SVG2DrawIOLib split-paths icon.svg -o icon-split.svg
# Then create library with CSS enabled
SVG2DrawIOLib create icon-split.svg --css -o colorable-icon.xml
This command:
- Detects paths with multiple M/m (moveto) commands
- Splits them into separate path elements
- Automatically preserves "donut holes" (nested paths)
- Adds CSS classes for individual color control
Useful for icons that have a single compound path but multiple distinct shapes.
Advanced Features
Color Editing
Enable color customization in DrawIO by injecting CSS classes:
# Basic color editing (fill colors only)
SVG2DrawIOLib create icons/ --css -o colorable-icons.xml
# Stroke colors only
SVG2DrawIOLib create icons/ --css --css-mode stroke -o colorable-icons.xml
# Both fill and stroke colors
SVG2DrawIOLib create icons/ --css --css-mode both -o colorable-icons.xml
# Custom default colors
SVG2DrawIOLib create icons/ --css --css-color "#FF0000" --css-stroke-color "#0000FF" -o colorable-icons.xml
# Disable currentColor preservation
SVG2DrawIOLib create icons/ --css --no-preserve-current-color -o colorable-icons.xml
CSS Modes:
fill(default): Generate CSS rules for fill colors onlystroke: Generate CSS rules for stroke colors onlyboth: Generate CSS rules for both fill and stroke colors
Features:
- Parses both
style="fill:#fff"attributes and directfill="#fff"attributes - Properly handles
fill="none"andstroke="none"(doesn't force colors) - Preserves
currentColorvalues by default for theme-aware icons - Supports custom default colors for fill and stroke
This allows users to change icon colors directly in DrawIO's interface. For icons with compound paths (single path containing multiple shapes), use split-paths first to enable per-shape color control.
Proportional Scaling
Scale icons proportionally while maintaining aspect ratio:
# Scale so longest side is 64px
SVG2DrawIOLib create icons/ --max-size 64 -o large-icons.xml
Fixed Dimensions
Set exact dimensions for all icons:
SVG2DrawIOLib create icons/ --width 50 --height 50 -o square-icons.xml
Custom Configuration
# Custom XML namespace
SVG2DrawIOLib create icons/ --namespace "http://custom.ns" -o library.xml
# Custom CSS colors
SVG2DrawIOLib create icons/ --css --css-color "#FF0000" --css-stroke-color "#0000FF" -o library.xml
Target Specific SVG Elements for Color Editing
The --tag option (short: -t) controls which SVG element type receives CSS classes when using --css. This is useful when your icons use different element types for their shapes.
Default behavior: Targets <path> elements (works for most icon libraries)
# Default: Add CSS classes to <path> elements
SVG2DrawIOLib create icons/ --css -o library.xml
# Target <circle> elements instead
SVG2DrawIOLib create icons/ --css --tag circle -o library.xml
# Target <rect> elements
SVG2DrawIOLib create icons/ --css --tag rect -o library.xml
# Target <ellipse> elements
SVG2DrawIOLib create icons/ --css --tag ellipse -o library.xml
When to use:
- Most icon libraries (Font Awesome, Material Icons, etc.) convert all shapes to
<path>elements, so the default works fine - If your SVGs primarily use
<circle>,<rect>, or other element types, specify that tag - Only elements of the specified type will get CSS classes for color editing
- You can only target one element type per command
Example: If your icon uses circles for dots and paths for lines, and you want to make the circles colorable:
SVG2DrawIOLib create icon.svg --css --tag circle -o library.xml
Note: The --tag option only affects CSS class injection. It has no effect without the --css flag.
Split by Folder
Organize icons by subdirectory structure:
# Create separate libraries for each subdirectory
SVG2DrawIOLib create icons/ -o FontAwesome.xml -R --split-by-folder
# Example directory structure:
# icons/
# Regular/
# icon1.svg
# icon2.svg
# Solid/
# icon3.svg
# Brands/
# icon4.svg
#
# Creates:
# FontAwesome-Regular.xml (2 icons)
# FontAwesome-Solid.xml (1 icon)
# FontAwesome-Brands.xml (1 icon)
This is useful for icon sets that are already organized by category in the filesystem.
How It Works
SVG2DrawIOLib converts SVG files into DrawIO's custom library format:
- Parses SVG files and extracts dimensions
- Optionally injects CSS classes for color editing support
- Encodes SVG as data URI with base64 encoding
- Wraps in mxGraphModel XML structure
- Compresses using zlib deflate algorithm
- Generates library XML compatible with DrawIO
For technical details about the conversion process, see ARCHITECTURE.md.
Python API
Use SVG2DrawIOLib programmatically:
from pathlib import Path
from SVG2DrawIOLib import SVGProcessor, LibraryManager, SVGProcessingOptions
# Configure processing options
options = SVGProcessingOptions(add_css=True, css_color="#000000")
# Process SVG file
processor = SVGProcessor(options)
icon = processor.process_svg_file(Path("icon.svg"), max_dimension=64)
# Create library
manager = LibraryManager()
metadata = manager.create_library([icon], Path("library.xml"))
print(f"Created library with {metadata.icon_count} icons")
For complete API documentation, see ARCHITECTURE.md.
License
SVG2DrawIOLib is distributed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file svg2drawiolib-1.2.1.tar.gz.
File metadata
- Download URL: svg2drawiolib-1.2.1.tar.gz
- Upload date:
- Size: 140.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fe43c4ec098037737431fe2c68ea2b499be937a5c806f8050f7d14f9b695cb63
|
|
| MD5 |
11c16bbcea7459c6ad8faad7f9b99955
|
|
| BLAKE2b-256 |
2b55f1d8c55219aa00e8dd78d68873561ff051f66251206ceb7d91901d822a40
|
Provenance
The following attestation bundles were made for svg2drawiolib-1.2.1.tar.gz:
Publisher:
publish.yml on jamesbconner/SVG2DrawIOLib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
svg2drawiolib-1.2.1.tar.gz -
Subject digest:
fe43c4ec098037737431fe2c68ea2b499be937a5c806f8050f7d14f9b695cb63 - Sigstore transparency entry: 931881251
- Sigstore integration time:
-
Permalink:
jamesbconner/SVG2DrawIOLib@41bf7fa140fae030c5008d3deae15fa00b6571e5 -
Branch / Tag:
refs/tags/v1.2.1 - Owner: https://github.com/jamesbconner
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@41bf7fa140fae030c5008d3deae15fa00b6571e5 -
Trigger Event:
release
-
Statement type:
File details
Details for the file svg2drawiolib-1.2.1-py3-none-any.whl.
File metadata
- Download URL: svg2drawiolib-1.2.1-py3-none-any.whl
- Upload date:
- Size: 51.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a414321c7dcc5ba09bc74dc59519761c1e99740417f40b0a974df35caa1cc02e
|
|
| MD5 |
3ac4a67de2f1e60cb8c3b487a1e1f72a
|
|
| BLAKE2b-256 |
07238829ff24df52b606ad3166987177a9600a731bbbb83f6a499439f26e94fa
|
Provenance
The following attestation bundles were made for svg2drawiolib-1.2.1-py3-none-any.whl:
Publisher:
publish.yml on jamesbconner/SVG2DrawIOLib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
svg2drawiolib-1.2.1-py3-none-any.whl -
Subject digest:
a414321c7dcc5ba09bc74dc59519761c1e99740417f40b0a974df35caa1cc02e - Sigstore transparency entry: 931881270
- Sigstore integration time:
-
Permalink:
jamesbconner/SVG2DrawIOLib@41bf7fa140fae030c5008d3deae15fa00b6571e5 -
Branch / Tag:
refs/tags/v1.2.1 - Owner: https://github.com/jamesbconner
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@41bf7fa140fae030c5008d3deae15fa00b6571e5 -
Trigger Event:
release
-
Statement type: