schablone is a library to create structured printed forms (svg format) and fill them with information. Its main purpose is to create labels for boxes in a storage system (for instance your local hacker space). Beyond that it is flexible enough to create many other structured documents, like for example resumes or business cards. Schablone broadly exploits the flexibility of the xml formats, especially svg. In future development also other xml formats like html might be deployed. It relies on the libraries svglue, svgutils and lxml (currently indirectly). Occasionally also the library Rsvg (gi.repository) is utilized.
schablone is a very flexible library to create structured svg files. The user must specify -template layers- of svg files with fields of images and text to fill in. The library stacks these layers and fills in the desired texts and images. The library might, for instance, be used to automize the creation of address labels in a django based e-commerce system.
The library also can be used for some special tasks like creating box labels or labels for smd containers (as seen in the image above).
schablone simplifies the process of automatically creating labels and fill them in. Whenever structured documents should be created and filled in by python, schablone offers a good workflow. This might for instance be helpful in a Django application. Also the inclusion of qr-codes is supported (using the library pyqrcode). The basic procedure is a three steps process:
- store frame SVG file which has the wished size
- stack layers of svg file templates
- fill in texts and images
Layers are served as SVG-files and may be created by hand-coding or by vector programs like inkscape. If it is wished to fill in texts and images in a layer, the according tags in the svg-file must contain a unique template-id. The creation of own templates is documented in Chapter create templates.
tbc
tbc
tbc save A4
tbc
The procedure may also be
The following examples show the basic usage of schablone's key features. A more detailed example, concluding all these features can be found in sample.py. The examples imply that the schablone library has been installed as decribed in Installation.
schablone can create generic templates. The result can be seen in samples/generic/generic.svg.
import schablone.generic
import os
if not os.path.exists(generic_label_dir):
os.makedirs(generic_label_dir)
genLabel = schablone.generic.generic()
genLabel.overwrite = True
genLabel.width = '200'
genLabel.height = '200'
genLabel.cpt_tspan['static_txt'] = u'Replace some text here.'
genLabel.cpt_flowpara['flow_txt'] = u'Also flow text may be replaced.'
genLabel.layer.add('tmpl_layer/tmpl_layer_1.svg')
genLabel.layer.add('tmpl_layer/tmpl_layer_2.svg')
fn = generic_label_dir + '/generic_qr.svg'
genLabel.create_qr('http://www.sappz.de', fn, 160, 160)
genLabel.layer.remove(1)
fn = generic_label_dir + '/' + 'generic.svg'
genLabel.save(fn)
The files tmpl_layer_1.svg and tmpl_layer_1.svg can be found in the folder tmpl_layer. It is important that a template-id-tag is added to all tags that should be changeable later (similar to the documented way of svglue). In this case these are:
static text:
<tspan
...
template-id="static_txt"
...
</tspan>
floating text:
<flowRoot
...
template-id="static_txt"
...
</flowRoot>
There are also some specialized applications of schablone. One of them is to create labels for mira smd containers. Exemplary outputs can be found in the image in chapter What can I use it for?.
import schablone.label
import os
if not os.path.exists(single_dir):
os.makedirs(single_dir)
smdLabel = schablone.label.smd_container()
smdLabel.overwrite = True
smdLabel.cut = False # if True, the frame is
# put in a separate file
# in red (for laser cutter).
smdLabel.content.title = 'SMD-Wid.'
smdLabel.content.package = '0805'
smdLabel.content.tolerance = '1%'
smdLabel.content.temperature_coefficient = 'TK100'
smdLabel.power = '1/8W'
smdLabel.content.value = '120k'
fn = single_dir + '/' + 'smd_caption_' + '120k' + '.svg'
smdLabel.save(fn)
smdLabel.content.value = '180k'
fn = single_dir + '/' + 'smd_caption_' + '180k' + '.svg'
smdLabel.save(fn)
In the case you want to generate a custom smd container label you must give it a name with its absolute template path:
smdLabel = schablone.label.smd_container('my_custom_label', '/path/to/custom_tmpl_path/')
Another special application is the creation of box labels. The exemplary result can be seen in samples/box_label/default_label.svg.
import schablone.label
import os
if not os.path.exists(box_label_dir):
os.makedirs(box_label_dir)
boxLabel = schablone.label.box()
boxLabel.overwrite = True
boxLabel.content.title = 'Ein Box Label'
boxLabel.content.project = 'Projekt A'
boxLabel.content.editor = 'A.G.'
boxLabel.content.location = 'Regal A, Reihe A'
boxLabel.content.brief_content = 'Einige Dinge die sich in der Box befinden ...'
fn = box_label_dir + '/' + 'default_label.svg'
boxLabel.save(fn)
boxLabel.label_type = 'extended'
vn = box_label_dir + '/' + 'extended_label.svg'
boxLabel.save(fn)
The function ----todo: link to function reference----- saves the history of all stored svg files in one DIN format file. The following example shows this on smd containers.
import schablone.label
if not os.path.exists(single_dir):
os.makedirs(single_dir)
smdLabel = schablone.label.smd_container()
smdLabel.overwrite = True
smdLabel.cut = True
smdLabel.content.title = 'SMD-Wid.'
smdLabel.content.package = '0805'
smdLabel.content.tolerance = '1%'
smdLabel.content.temperature_coefficient = 'TK100'
smdLabel.power = '1/8W'
res_e12 = [
'1', '1.2', '1.5', '1.6', '1.8', '2.2', '2.7', '3.3', '3.9', '4.7', '5.6',
'6.8', '8.2', '10', '12', '15', '18', '22', '27', '33', '39', '47', '56',
'68', '82', '100', '120', '150', '180', '220', '270', '330', '390', '470',
'560', '680', '820', '1k', '1k2', '1k5', '1k8', '2k2', '2k7', '3k3', '3k9',
'4k7', '5k6', '6k8', '8k2', '10k', '12k', '15k', '18k', '22k', '27k',
'33k', '39k', '47k', '56k', '68k', '82k', '100k', '120k', '150k', '180k',
'220k', '330k', '390k', '470k', '560k', '680k', '820k'
]
cap = ['100n']
cpt_vals = res_e12 + cap
for val in cpt_vals:
smdLabel.content.value = val
fn = single_dir + '/' + 'smd_caption_' + val + '.svg'
smdLabel.save(fn)
din = 'a4'
fn_Ax = Ax_dir + '/' + din + '.svg'
smdLabel.saveAx(fn_Ax, din)
It relies on the libraries
Occasionally also the library Rsvg (gi.repository) is utilized. Installation using pip and aptitude (tested on Ubuntu 14.04):
$ [sudo] pip install svgutils lxml $ [sudo] pip install pyqrcode $ [sudo] apt-get install gir1.2-rsvg-2.0 python3-cairo
When using virtual environments handling Rsvg from gi.repository can be tedious. One solution is to install PyGObject system-wide with your package manager (or compile it manually) and link it in your virtualenv. For an Arch Linux with Python 3.5.2 and pyenv for example this will be:
$ [sudo] pacman -S python-gobject $ ln -s /usr/lib/python3.5/site-packages/gi* ~/.pyenv/versions/3.5.2/lib/python3.5/site-packages
Until its newest commits are published on PyPi prefer to install svglue from its github repository:
$ [sudo] pip install git+https://github.com/mbr/svglue.git@master
Install all Requirements and then:
$ [sudo] pip install git+https://github.com/ticktronaut/schablone.git@master
Copyright (c) 2016 Andreas Gschossmann
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.