svgmanip

|Say Thanks!|

svgmanip is a library that helps import and composite together existing SVG files. It supports a superset of the features supported by svgutils. For example, you can easily rotate and scale SVGs on the fly. In Warfrogs, this code:

.. code:: python

from svgmanip import Element
output = Element(384, 356)  # size of the output file.

fate = Element('assets/fate.svg').rotate(-15)
skip = Element('assets/skip.svg').rotate(-5)
attack = Element('assets/attack.svg').rotate(5)
output.placeat(fate, 0.73, 23.55)
output.placeat(skip, 107.81, 8.76)
output.placeat(attack, 170.9, 0.08)

output.dump('output.svg')
output.save_as_png('output.png', 1024)

Generates this image:

(The cropped edges are because of the output dimensions, which are customizable.)

Unlike svgutils <https://github.com/btel/svg_utils>_ (which this module is based on), .rotate() rotates about the center of the graphic, instead of the top left corner. This produces results the user would expect.

Did you notice that you didn't need to specify the dimensions of an imported image? That's because svgmanip detects it automatically behind the scenes!

.dumps() grabs the full, real SVG code, not just the root element like .tostr() in svgutils.

Install

::

    npm install -g svgexport  # if you want to be able to export to PNG
    pip install svgmanip

Documentation
-------------

``.rotate()`` additionally supports passing optional ``x`` and ``y``
coordinates.

Since the ``Element`` class inherits from the ``Figure`` class in
``svgutils``, it also supports these ``svgutils`` methods:

-  ``.scale(factor)`` - scale the SVG by a particular factor
-  ``.find_id(element_id)`` - find the inner SVG element with the given
   id. This method is guranteed to return an ``Element`` object
   from\ ``svgmanip``.
-  ``.find_ids(element_ids)`` - find the inner SVG elements with the
   given ids. This returns a `Panel
   object <https://svgutils.readthedocs.io/en/latest/compose.html#svgutils.compose.Panel>`__
   from ``svgutils``.

``svgmanip`` also supports these methods in addition to the ones listed
in the example:

-  ``.dumps`` - dump to a string
-  ``.loads`` - load from a string
-  ``.load`` - load from a file (*note:* using the default constructor
   is reccomended in this context)
-  ``.to_png`` - returns the generated PNG as a string

License
-------

Apache 2.0. Example image of the Warfrogs cards is licensed under the
`CC BY-NC-ND
4.0 <https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode>`__.

.. |Say Thanks!| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
   :target: https://saythanks.io/to/CrazyPython