Metadata-Version: 2.4
Name: drawsvg-ui
Version: 0.5.0
Summary: GUI for creating drawsvg scenes with PySide6
Author: UI_drawsvg maintainers
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: drawsvg<3,>=2.4
Requires-Dist: PySide6<7,>=6.9.2
Requires-Dist: PySide6-Addons<7,>=6.9.2
Requires-Dist: PySide6-Essentials<7,>=6.9.2
Requires-Dist: shiboken6<7,>=6.9.2
Dynamic: license-file

# DrawSVG UI

This repository provides a graphical user interface designed to make it easier to create files with the [drawsvg](https://pypi.org/project/drawsvg/) library.  
Instead of writing raw Python code by hand, you can visually place, move, and edit shapes on a canvas, then export your work as a ready-to-use `drawsvg` file. The UI runs on PySide6 and comes with a property inspector, snapping/grid helpers and a set of ready-made shapes.

The goal of this project is to help users quickly prototype and generate `drawsvg` code through an intuitive drag-and-drop UI.

## Requirements

The application requires **Python 3.10**.  
Dependencies include:

* **drawsvg**  
* **PySide6**


## Install via PyPI
You can install the packaged app and launch it via the generated executable script:

```bash
python -m pip install --upgrade drawsvg-ui
drawsvg-ui  # on Windows this is available as drawsvg-ui.exe
```


## Install all via dependencies with:

```bash
python -m pip install -r requirements.txt
```

## Running the Application
After installing the dependencies, start the application with:

```bash
python src/main.py
```

## UI Features

### Canvas and navigation
* A4 canvas with grid/subgrid preview; toggle visibility via `Edit → Show grid`.
* Snap-to-grid movement and resizing; hold `Alt` to place/drag/resize freely.
* Automatic extra A4 pages when objects cross page borders; empty pages are cleaned up again.
* Zoom with `Ctrl`/`Alt` + mouse wheel; pan with middle button or right-button drag (right click on empty space resets zoom).
* Rotation handle above the selection; snaps to 5° steps, hold `Alt` for smooth rotation with a live angle readout.

### Shape palette
* Drag shapes from the palette or click to drop them at the view center.
* Shapes: rectangle, rounded rectangle, split rounded rectangle (adjustable header), ellipse/circle, triangle, diamond, line, arrow, block arrow, curvy right bracket, text box, and a folder-tree placeholder.

### Editing and layout
* Rubber-band selection; add to selection with `Ctrl`/`Shift` click; duplicate selection with `Ctrl` + drag.
* Resize via handles; items snap while moving/resizing unless `Alt` is held.
* Align multiple items (left/center/right, top/middle/bottom, snap to grid) from the context menu.
* Group/ungroup selections (`Ctrl+G` / `Ctrl+Shift+G`) and change z-order (bring forward/back).
* Delete with the `Delete` key or clear everything via `Edit → Clear canvas`. Full undo/redo stack (`Ctrl+Z`, `Ctrl+Y` / `Ctrl+Shift+Z`).

### Styling, text, and labels
* Context menu or properties panel to edit fill/stroke color, opacity, stroke width, and line style (solid/dashed/dotted).
* Corner radius for rectangles; adjustable divider and separate top/bottom fills for split rounded rectangles.
* Arrowheads on lines/arrows with configurable width/height; block arrow head/shaft ratios; curvy bracket hook depth.
* Built-in labels for supported shapes: edit text inline or in the properties panel, set font family/size/color, and horizontal/vertical alignment.
* Text items support multi-line content, font and padding, alignment, and left-to-right or right-to-left direction.

### Properties panel
* Live inspector synced to the current selection: position, rotation, scale, z-value, size, stroke/fill, and shape-specific options.
* Dedicated text tab for labels/text content including font, color, padding, alignment, and direction controls.

### Import/Export
* Load or save scenes as ready-to-run `drawsvg` Python files via the `File` menu.

## License

This project is licensed under the GNU General Public License v3.0 (GPLv3).

You may use, modify and distribute this software under the terms of the GPL.
Any derivative work must also be distributed under the same license.


