svglab 0.1.0__tar.gz

svglab-0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Tomáš Režňák
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

svglab-0.1.0/PKG-INFO

@@ -0,0 +1,302 @@
+Metadata-Version: 2.1
+Name: svglab
+Version: 0.1.0
+Summary: A manipulation and optimization library for Scalable Vector Graphics
+License: MIT
+Author: Tomáš Režňák
+Author-email: tomas.reznak@volny.cz
+Requires-Python: >=3.10,<4.0
+Classifier: Framework :: Pydantic :: 2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Multimedia :: Graphics :: Editors :: Vector-Based
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Text Processing :: Markup :: XML
+Classifier: Typing :: Typed
+Requires-Dist: beautifulsoup4 (>=4.12.3,<5.0.0)
+Requires-Dist: bidict (>=0.23.1,<0.24.0)
+Requires-Dist: html5lib (>=1.1,<2.0)
+Requires-Dist: lark (>=1.2.2,<2.0.0)
+Requires-Dist: lxml (>=5.3.0,<6.0.0)
+Requires-Dist: pydantic (>=2.10.4,<3.0.0)
+Requires-Dist: pydantic-extra-types (>=2.10.1,<3.0.0)
+Requires-Dist: pyright (>=1.1.391,<2.0.0)
+Requires-Dist: readable-number (>=0.1.3,<0.2.0)
+Requires-Dist: svgpathtools (>=1.6.1,<2.0.0)
+Description-Content-Type: text/markdown
+
+<a id="readme-top"></a>
+
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/reznakt/svglab/check.yml)
+![GitHub License](https://img.shields.io/github/license/reznakt/svglab)
+![Python version](https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12%20|%203.13-blue)
+![Maintenance](https://img.shields.io/maintenance/yes/2025)
+![GitHub repo size](https://img.shields.io/github/repo-size/reznakt/svglab)
+![GitHub Repo stars](https://img.shields.io/github/stars/reznakt/svglab?style=flat)
+
+<br />
+<div align="center">
+  <img width="150" height="150" src="https://www.reshot.com/download/icons/HSMU75PJ3C/reshot-icon-flask-HSMU75PJ3C.svg" />
+
+  <h3 align="center">svglab</h3>
+
+  <p align="center">
+    <em>A manipulation and optimization library for Scalable Vector Graphics</em>
+  </p>
+</div>
+<hr />
+
+### Table of Contents
+
+<ul>
+  <li>
+    <a href="#about-the-project">About The Project</a>
+  </li>
+  <li>
+    <a href="#getting-started">Getting Started</a>
+    <ul>
+      <li><a href="#prerequisites">Prerequisites</a></li>
+      <li><a href="#installation">Installation</a></li>
+    </ul>
+  </li>
+  <li><a href="#usage">Usage</a></li>
+  <li>
+    <a href="#development">Development</a>
+    <ul>
+      <li><a href="#setup">Setup</a></li>
+      <li><a href="#common-tasks">Common tasks</a></li>
+    </ul>
+  </li>
+  <li><a href="#license">License</a></li>
+</ul>
+
+## About The Project
+
+### Features
+
+- SVG parsing, manipulation, and writing
+- Support for all SVG 1.1 elements and attributes
+- Support for special XML elements (`CDATA`, comments, text)
+- Attributes are parsed into native Python types for easy manipulation
+- Highly configurable formatting options:
+  - indentation level
+  - maximum precision for floating-point numbers
+  - color mode (`rgb`, `rgba`, `hsl`, `hex`, `named`)
+  - relative/absolute path commands
+  - scientific notation for small/large numbers
+  - and many more...
+- Strong type safety:
+  - one class per distinct SVG element
+  - typed attributes
+  - runtime validation thanks to [pydantic](https://pypi.org/project/pydantic/)
+- Support for all [beautifulsoup4](https://pypi.org/project/beautifulsoup4/) parsers (e.g., `html.parser`, `lxml`, `html5lib`)
+
+```mermaid
+---
+title: Element hierarchy
+---
+
+graph TD
+  Element:::abc --> TextElement
+  Element --> Tag
+
+  Tag:::abc --> PairedTag
+
+  PairedTag:::abc --> G
+  PairedTag --> Svg
+  PairedTag --> etc1[...]
+
+  Tag --> Rect
+  Tag --> Circle
+  Tag --> etc2[...]
+
+  TextElement:::abc --> Text
+  TextElement --> Comment
+  TextElement --> CData
+
+  etc1:::etc
+  etc2:::etc
+
+  classDef abc stroke:white,stroke-width:2px;
+  classDef etc stroke:gray,stroke-width:2px;
+  classDef default stroke:orange,stroke-width:2px;
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Getting Started
+
+### Prerequisites
+
+- [CPython](https://www.python.org/) $\geq$ 3.10
+- [Poetry](https://python-poetry.org/) (development only)
+
+### Installation
+
+**From PyPi**:
+```sh
+pip install svglab
+```
+**From source**:
+```sh
+# Via HTTPS
+pip install git+https://github.com/reznakt/svglab.git
+
+# Via SSH
+pip install git+ssh://git@github.com/reznakt/svglab.git
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Usage
+
+```python
+from svglab import (
+    CData,
+    Comment,
+    G,
+    Path,
+    Polyline,
+    RawText,
+    Rect,
+    parse_svg,
+)
+from svglab.attrparse import Color, D, Length, Point, SkewX, Translate
+from svglab.serialize import Formatter, set_formatter
+
+
+# Configure custom formatting options
+set_formatter(Formatter(indent=4, max_precision=2, color_mode="rgb"))
+
+
+# Parse an existing SVG file
+svg = parse_svg(
+    """
+    <svg xmlns="http://www.w3.org/2000/svg">
+      <g>
+          <rect
+            id="background"
+            width="100cm"
+            height="100%"
+            transform="rotate(45)"
+            stroke="red"
+          />
+          <rect color="hsl(0, 100%, 100%)"/>
+          <!-- This is a comment -->
+          <![CDATA[.background { fill: blue; }]]>
+          Hello SVG!
+          <path d="M 10,10 L 100,100 Q 100,100 50,50 Z"/>
+          <polygon points="0,0 100,0 100,100 0,100"/>
+      </g>
+    </svg>
+"""
+)
+
+print(svg)
+
+# Create an element programmatically
+group = G().add_children(
+    Rect(
+        width=Length(15, "px"),
+        height=Length(20),
+        transform=[SkewX(45.123), Translate(10, 20)],
+        color=Color("#ff0000"),
+    ),
+    Comment("This is a comment"),
+    CData(".background { fill: blue; }"),
+    RawText("Hello SVG!"),
+    Path(
+        d=D()
+        .move_to(Point(10, 10))
+        .line_to(Point(100, 100))
+        .quadratic_bezier_to(Point(100, 100), Point(50, 50))
+        .move_to(Point(50, 50))
+        .cubic_bezier_to(
+            Point(100, 100), Point(100, 100), Point(10, 10)
+        )
+        .arc_to(
+            Point(50, 50), 90, Point(100, 100), large=True, sweep=False
+        )
+        .close()
+    ),
+    Polyline(
+        points=[
+            Point(0, 0),
+            Point(100, 0),
+            Point(100, 100),
+            Point(0, 100),
+        ],
+        stroke_linecap="square",
+        opacity=0.5,
+    ),
+)
+
+# Add the element to the SVG
+svg.add_child(group)
+
+# Manipulate attributes
+print(svg.xmlns)  # http://www.w3.org/2000/svg
+svg.xmlns = "http://example.com"
+
+# Save to a file
+svg.save("output.svg")
+
+# Search the element tree
+print(svg.find(G).find(Rect).width)
+print(*svg.find_all(Rect), sep="\n")
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Development
+
+### Setup
+
+```sh
+# Install dependencies
+poetry install
+
+# Activate the virtual environment
+poetry shell
+
+# Optional: Install pre-commit hooks
+pre-commit install
+```
+
+### Common tasks
+
+```sh
+# Run tests
+poe test
+
+# Run type checker
+poe typecheck
+
+# Run linter
+poe lint
+
+# Fix linting errors
+poe lint-fix
+
+# Run formatter
+poe format
+
+# Fix formatting errors
+poe format-fix
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## License
+
+This software is distributed under the MIT License. See [`LICENSE`](LICENSE) for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+

svglab-0.1.0/README.md

@@ -0,0 +1,267 @@
+<a id="readme-top"></a>
+
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/reznakt/svglab/check.yml)
+![GitHub License](https://img.shields.io/github/license/reznakt/svglab)
+![Python version](https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12%20|%203.13-blue)
+![Maintenance](https://img.shields.io/maintenance/yes/2025)
+![GitHub repo size](https://img.shields.io/github/repo-size/reznakt/svglab)
+![GitHub Repo stars](https://img.shields.io/github/stars/reznakt/svglab?style=flat)
+
+<br />
+<div align="center">
+  <img width="150" height="150" src="https://www.reshot.com/download/icons/HSMU75PJ3C/reshot-icon-flask-HSMU75PJ3C.svg" />
+
+  <h3 align="center">svglab</h3>
+
+  <p align="center">
+    <em>A manipulation and optimization library for Scalable Vector Graphics</em>
+  </p>
+</div>
+<hr />
+
+### Table of Contents
+
+<ul>
+  <li>
+    <a href="#about-the-project">About The Project</a>
+  </li>
+  <li>
+    <a href="#getting-started">Getting Started</a>
+    <ul>
+      <li><a href="#prerequisites">Prerequisites</a></li>
+      <li><a href="#installation">Installation</a></li>
+    </ul>
+  </li>
+  <li><a href="#usage">Usage</a></li>
+  <li>
+    <a href="#development">Development</a>
+    <ul>
+      <li><a href="#setup">Setup</a></li>
+      <li><a href="#common-tasks">Common tasks</a></li>
+    </ul>
+  </li>
+  <li><a href="#license">License</a></li>
+</ul>
+
+## About The Project
+
+### Features
+
+- SVG parsing, manipulation, and writing
+- Support for all SVG 1.1 elements and attributes
+- Support for special XML elements (`CDATA`, comments, text)
+- Attributes are parsed into native Python types for easy manipulation
+- Highly configurable formatting options:
+  - indentation level
+  - maximum precision for floating-point numbers
+  - color mode (`rgb`, `rgba`, `hsl`, `hex`, `named`)
+  - relative/absolute path commands
+  - scientific notation for small/large numbers
+  - and many more...
+- Strong type safety:
+  - one class per distinct SVG element
+  - typed attributes
+  - runtime validation thanks to [pydantic](https://pypi.org/project/pydantic/)
+- Support for all [beautifulsoup4](https://pypi.org/project/beautifulsoup4/) parsers (e.g., `html.parser`, `lxml`, `html5lib`)
+
+```mermaid
+---
+title: Element hierarchy
+---
+
+graph TD
+  Element:::abc --> TextElement
+  Element --> Tag
+
+  Tag:::abc --> PairedTag
+
+  PairedTag:::abc --> G
+  PairedTag --> Svg
+  PairedTag --> etc1[...]
+
+  Tag --> Rect
+  Tag --> Circle
+  Tag --> etc2[...]
+
+  TextElement:::abc --> Text
+  TextElement --> Comment
+  TextElement --> CData
+
+  etc1:::etc
+  etc2:::etc
+
+  classDef abc stroke:white,stroke-width:2px;
+  classDef etc stroke:gray,stroke-width:2px;
+  classDef default stroke:orange,stroke-width:2px;
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Getting Started
+
+### Prerequisites
+
+- [CPython](https://www.python.org/) $\geq$ 3.10
+- [Poetry](https://python-poetry.org/) (development only)
+
+### Installation
+
+**From PyPi**:
+```sh
+pip install svglab
+```
+**From source**:
+```sh
+# Via HTTPS
+pip install git+https://github.com/reznakt/svglab.git
+
+# Via SSH
+pip install git+ssh://git@github.com/reznakt/svglab.git
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Usage
+
+```python
+from svglab import (
+    CData,
+    Comment,
+    G,
+    Path,
+    Polyline,
+    RawText,
+    Rect,
+    parse_svg,
+)
+from svglab.attrparse import Color, D, Length, Point, SkewX, Translate
+from svglab.serialize import Formatter, set_formatter
+
+
+# Configure custom formatting options
+set_formatter(Formatter(indent=4, max_precision=2, color_mode="rgb"))
+
+
+# Parse an existing SVG file
+svg = parse_svg(
+    """
+    <svg xmlns="http://www.w3.org/2000/svg">
+      <g>
+          <rect
+            id="background"
+            width="100cm"
+            height="100%"
+            transform="rotate(45)"
+            stroke="red"
+          />
+          <rect color="hsl(0, 100%, 100%)"/>
+          <!-- This is a comment -->
+          <![CDATA[.background { fill: blue; }]]>
+          Hello SVG!
+          <path d="M 10,10 L 100,100 Q 100,100 50,50 Z"/>
+          <polygon points="0,0 100,0 100,100 0,100"/>
+      </g>
+    </svg>
+"""
+)
+
+print(svg)
+
+# Create an element programmatically
+group = G().add_children(
+    Rect(
+        width=Length(15, "px"),
+        height=Length(20),
+        transform=[SkewX(45.123), Translate(10, 20)],
+        color=Color("#ff0000"),
+    ),
+    Comment("This is a comment"),
+    CData(".background { fill: blue; }"),
+    RawText("Hello SVG!"),
+    Path(
+        d=D()
+        .move_to(Point(10, 10))
+        .line_to(Point(100, 100))
+        .quadratic_bezier_to(Point(100, 100), Point(50, 50))
+        .move_to(Point(50, 50))
+        .cubic_bezier_to(
+            Point(100, 100), Point(100, 100), Point(10, 10)
+        )
+        .arc_to(
+            Point(50, 50), 90, Point(100, 100), large=True, sweep=False
+        )
+        .close()
+    ),
+    Polyline(
+        points=[
+            Point(0, 0),
+            Point(100, 0),
+            Point(100, 100),
+            Point(0, 100),
+        ],
+        stroke_linecap="square",
+        opacity=0.5,
+    ),
+)
+
+# Add the element to the SVG
+svg.add_child(group)
+
+# Manipulate attributes
+print(svg.xmlns)  # http://www.w3.org/2000/svg
+svg.xmlns = "http://example.com"
+
+# Save to a file
+svg.save("output.svg")
+
+# Search the element tree
+print(svg.find(G).find(Rect).width)
+print(*svg.find_all(Rect), sep="\n")
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## Development
+
+### Setup
+
+```sh
+# Install dependencies
+poetry install
+
+# Activate the virtual environment
+poetry shell
+
+# Optional: Install pre-commit hooks
+pre-commit install
+```
+
+### Common tasks
+
+```sh
+# Run tests
+poe test
+
+# Run type checker
+poe typecheck
+
+# Run linter
+poe lint
+
+# Fix linting errors
+poe lint-fix
+
+# Run formatter
+poe format
+
+# Fix formatting errors
+poe format-fix
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## License
+
+This software is distributed under the MIT License. See [`LICENSE`](LICENSE) for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>