commit cddd828ce024e6aabbe2f65106c3313c6fda9de8 · cduck.me/drawsvg

+167

DESCRIPTION.rst

···

       1
       1
       +
       Most common SVG tags are supported and others can easily be added by

     

       2
       2
       +
       writing a small subclass of ``DrawableBasicElement`` or

     

       3
       3
       +
       ``DrawableParentElement``.

     

       4
       4
       +
       

     

       5
       5
       +
       Install

     

       6
       6
       +
       =======

     

       7
       7
       +
       

     

       8
       8
       +
       drawSvg is available on PyPI:

     

       9
       9
       +
       

     

       10
       10
       +
       ::

     

       11
       11
       +
       

     

       12
       12
       +
           $ pip3 install drawSvg

     

       13
       13
       +
       

     

       14
       14
       +
       Examples

     

       15
       15
       +
       ========

     

       16
       16
       +
       

     

       17
       17
       +
       Basic drawing elements

     

       18
       18
       +
       ~~~~~~~~~~~~~~~~~~~~~~

     

       19
       19
       +
       

     

       20
       20
       +
       .. code:: python

     

       21
       21
       +
       

     

       22
       22
       +
           d = draw.Drawing(200, 100, origin='center')

     

       23
       23
       +
       

     

       24
       24
       +
           d.append(draw.Lines(-80, -45,

     

       25
       25
       +
                               70, -49,

     

       26
       26
       +
                               95, 49,

     

       27
       27
       +
                               -90, 40,

     

       28
       28
       +
                               close=False,

     

       29
       29
       +
                       fill='#eeee00',

     

       30
       30
       +
                       stroke='black'))

     

       31
       31
       +
       

     

       32
       32
       +
           d.append(draw.Rectangle(0,0,40,50, fill='#1248ff'))

     

       33
       33
       +
           d.append(draw.Circle(-40, -10, 30,

     

       34
       34
       +
                       fill='red', stroke_width=2, stroke='black'))

     

       35
       35
       +
       

     

       36
       36
       +
           p = draw.Path(stroke_width=2, stroke='green',

     

       37
       37
       +
                         fill='black', fill_opacity=0.5)

     

       38
       38
       +
           p.M(-30,5)  # Start path at point (-30, 5)

     

       39
       39
       +
           p.l(60,30)  # Draw line to (60, 30)

     

       40
       40
       +
           p.h(-70)    # Draw horizontal line to x=-70

     

       41
       41
       +
           p.Z()       # Draw line to start

     

       42
       42
       +
           d.append(p)

     

       43
       43
       +
       

     

       44
       44
       +
           d.append(draw.ArcLine(60,-20,20,60,270,

     

       45
       45
       +
                       stroke='red', stroke_width=5, fill='red', fill_opacity=0.2))

     

       46
       46
       +
           d.append(draw.Arc(60,-20,20,60,270,cw=False,

     

       47
       47
       +
                       stroke='green', stroke_width=3, fill='none'))

     

       48
       48
       +
           d.append(draw.Arc(60,-20,20,270,60,cw=True,

     

       49
       49
       +
                       stroke='blue', stroke_width=1, fill='black', fill_opacity=0.3))

     

       50
       50
       +
       

     

       51
       51
       +
           d.setPixelScale(2)  # Set number of pixels per geometry unit

     

       52
       52
       +
           #d.setRenderSize(400,200)  # Alternative to setPixelScale

     

       53
       53
       +
           d.saveSvg('example.svg')

     

       54
       54
       +
           d.savePng('example.png')

     

       55
       55
       +
       

     

       56
       56
       +
           # Display in iPython notebook

     

       57
       57
       +
           d.rasterize()  # Display as PNG

     

       58
       58
       +
           d  # Display as SVG

     

       59
       59
       +
       

     

       60
       60
       +
       .. image:: https://github.com/cduck/drawSvg/raw/master/example1.png

     

       61
       61
       +
          :alt: Example output image

     

       62
       62
       +
       

     

       63
       63
       +
       Gradients

     

       64
       64
       +
       ~~~~~~~~~

     

       65
       65
       +
       

     

       66
       66
       +
       .. code:: python

     

       67
       67
       +
       

     

       68
       68
       +
           d = draw.Drawing(1.5, 0.8, origin='center')

     

       69
       69
       +
       

     

       70
       70
       +
           d.draw(draw.Rectangle(-0.75,-0.5,1.5,1, fill='#ddd'))

     

       71
       71
       +
       

     

       72
       72
       +
           # Create gradient

     

       73
       73
       +
           gradient = draw.RadialGradient(0,-0.35,0.7*10)

     

       74
       74
       +
           gradient.addStop(0.5/0.7/10, 'green', 1)

     

       75
       75
       +
           gradient.addStop(1/10, 'red', 0)

     

       76
       76
       +
       

     

       77
       77
       +
           # Draw a shape to fill with the gradient

     

       78
       78
       +
           p = draw.Path(fill=gradient, stroke='black', stroke_width=0.002)

     

       79
       79
       +
           p.arc(0,-0.35,0.7,30,120)

     

       80
       80
       +
           p.arc(0,-0.35,0.5,120,30,cw=True, includeL=True)

     

       81
       81
       +
           p.Z()

     

       82
       82
       +
           d.append(p)

     

       83
       83
       +
       

     

       84
       84
       +
           # Draw another shape to fill with the same gradient

     

       85
       85
       +
           p = draw.Path(fill=gradient, stroke='red', stroke_width=0.002)

     

       86
       86
       +
           p.arc(0,-0.35,0.75,130,160)

     

       87
       87
       +
           p.arc(0,-0.35,0,160,130,cw=True, includeL=True)

     

       88
       88
       +
           p.Z()

     

       89
       89
       +
           d.append(p)

     

       90
       90
       +
       

     

       91
       91
       +
           # Another gradient

     

       92
       92
       +
           gradient2 = draw.LinearGradient(0.1,-0.35,0.1+0.6,-0.35+0.2)

     

       93
       93
       +
           gradient2.addStop(0, 'green', 1)

     

       94
       94
       +
           gradient2.addStop(1, 'red', 0)

     

       95
       95
       +
           d.append(draw.Rectangle(0.1,-0.35,0.6,0.2,

     

       96
       96
       +
                                   stroke='black', stroke_width=0.002,

     

       97
       97
       +
                                   fill=gradient2))

     

       98
       98
       +
       

     

       99
       99
       +
           # Display

     

       100
       100
       +
           d.setRenderSize(w=600)

     

       101
       101
       +
           d

     

       102
       102
       +
       

     

       103
       103
       +
       .. image:: https://github.com/cduck/drawSvg/raw/master/example2.png

     

       104
       104
       +
          :alt: Example output image

     

       105
       105
       +
       

     

       106
       106
       +
       Duplicate geometry and clip paths

     

       107
       107
       +
       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

     

       108
       108
       +
       

     

       109
       109
       +
       .. code:: python

     

       110
       110
       +
       

     

       111
       111
       +
           d = draw.Drawing(1.4, 1.4, origin='center')

     

       112
       112
       +
       

     

       113
       113
       +
           # Define clip path

     

       114
       114
       +
           clip = draw.ClipPath()

     

       115
       115
       +
           clip.append(draw.Rectangle(-.25,.25-1,1,1))

     

       116
       116
       +
       

     

       117
       117
       +
           # Draw a cropped circle

     

       118
       118
       +
           c = draw.Circle(0,0,0.5, stroke_width='0.01', stroke='black',

     

       119
       119
       +
                                    fill_opacity=0.3, clip_path=clip,

     

       120
       120
       +
                                    id='circle')

     

       121
       121
       +
           d.append(c)

     

       122
       122
       +
       

     

       123
       123
       +
           # Make a transparent copy, cropped again

     

       124
       124
       +
           g = draw.Group(opacity=0.5, clip_path=clip)

     

       125
       125
       +
           g.append(draw.Use('circle', 0.25,0.1))

     

       126
       126
       +
           d.append(g)

     

       127
       127
       +
       

     

       128
       128
       +
           # Display

     

       129
       129
       +
           d.setRenderSize(400)

     

       130
       130
       +
           d.rasterize()

     

       131
       131
       +
       

     

       132
       132
       +
       .. image:: https://github.com/cduck/drawSvg/raw/master/example3.png

     

       133
       133
       +
          :alt: Example output image

     

       134
       134
       +
       

     

       135
       135
       +
       Implementing other SVG tags

     

       136
       136
       +
       ~~~~~~~~~~~~~~~~~~~~~~~~~~~

     

       137
       137
       +
       

     

       138
       138
       +
       .. code:: python

     

       139
       139
       +
       

     

       140
       140
       +
           # Subclass DrawingBasicElement if it cannot have child nodes

     

       141
       141
       +
           # Subclass DrawingParentElement otherwise

     

       142
       142
       +
           # Subclass DrawingDef if it must go between <def></def> tags in an SVG

     

       143
       143
       +
           class Hyperlink(draw.DrawingParentElement):

     

       144
       144
       +
               TAG_NAME = 'a'

     

       145
       145
       +
               def __init__(self, href, target=None, **kwargs):

     

       146
       146
       +
                   # Other init logic...

     

       147
       147
       +
                   # Keyword arguments to super().__init__() correspond to SVG node

     

       148
       148
       +
                   # arguments: stroke_width=5 -> stroke-width="5"

     

       149
       149
       +
                   super().__init__(href=href, target=target, **kwargs)

     

       150
       150
       +
       

     

       151
       151
       +
           d = draw.Drawing(1, 1.2, origin='center')

     

       152
       152
       +
       

     

       153
       153
       +
           # Create hyperlink

     

       154
       154
       +
           hlink = Hyperlink('https://www.python.org', target='_blank',

     

       155
       155
       +
                             transform='skewY(-30)')

     

       156
       156
       +
           # Add child elements

     

       157
       157
       +
           hlink.append(draw.Circle(0,0,0.5, fill='green'))

     

       158
       158
       +
           hlink.append(draw.Text('Hyperlink',0.2, 0,0, center=0.6, fill='white'))

     

       159
       159
       +
       

     

       160
       160
       +
           # Draw and display

     

       161
       161
       +
           d.append(hlink)

     

       162
       162
       +
           d.setRenderSize(200)

     

       163
       163
       +
           d

     

       164
       164
       +
       

     

       165
       165
       +
       .. image:: https://github.com/cduck/drawSvg/raw/master/example4.png

     

       166
       166
       +
          :alt: Example output image

     

       167
       167
       +

+32

setup.py

···

       1
       1
       +
       import subprocess

     

       2
       2
       +
       from setuptools import setup

     

       3
       3
       +
       

     

       4
       4
       +
       try:

     

       5
       5
       +
           with open('DESCRIPTION.rst', 'r') as f:

     

       6
       6
       +
               longDesc = f.read()

     

       7
       7
       +
       except:

     

       8
       8
       +
           print('Warning: Could not open DESCRIPTION.rst.  long_description will be set to None.')

     

       9
       9
       +
           longDesc = None

     

       10
       10
       +
       

     

       11
       11
       +
       setup(

     

       12
       12
       +
           name = 'drawSvg',

     

       13
       13
       +
           packages = ['drawSvg'],

     

       14
       14
       +
           version = '1.0.0',

     

       15
       15
       +
           description = 'This is a Python 3 library for programmatically generating SVG images (vector drawings) and rendering them or displaying them in an iPython notebook.',

     

       16
       16
       +
           long_description = longDesc,

     

       17
       17
       +
           author = 'Casey Duckering',

     

       18
       18
       +
           #author_email = '',

     

       19
       19
       +
           url = 'https://github.com/cduck/drawSvg',

     

       20
       20
       +
           download_url = 'https://github.com/cduck/drawSvg/archive/1.0.0.tar.gz',

     

       21
       21
       +
           keywords = ['SVG', 'draw', 'graphics', 'iPython', 'Jupyter'],

     

       22
       22
       +
           classifiers = [

     

       23
       23
       +
               'License :: OSI Approved :: MIT License',

     

       24
       24
       +
               'Programming Language :: Python :: 3',

     

       25
       25
       +
               'Framework :: IPython',

     

       26
       26
       +
               'Framework :: Jupyter',

     

       27
       27
       +
           ],

     

       28
       28
       +
           requires = [

     

       29
       29
       +
               'cairoSVG',

     

       30
       30
       +
           ],

     

       31
       31
       +
       )

     

       32
       32
       +