pyconizr 0.1a5

Installation

As straighforward as it can be, using pip:

pip install pyconizr

Usage

From the command line:

pyconizr [options]

From python:

from pyconizr import iconize
iconize(option1=val1, option2=val2, ...)

Default behavior

By default, pyconizr will:

• optimize every SVG file in the current working directory using scour (without overwriting them)

• concatenate them to create an optimized SVG sprite in current_working_dir/sprites/sourcedir_name.svg

• create a PNG sprite from the SVG sprite as current_working_dir/sprites/sourcedir_name.png

• create a CSS/SCSS/whatever file at current_working_dir/sourcedir_name

This can be configured using the following options.

Options

All options should be prefixed by -- in the command line (if not using the shortcut), or should be provided as keyword arguments to the iconize function.

in, -i

The input directory or files (as a wildcard) that should be used to generate the sprite. Only valid SVG files will be taken into account, so there is no need to add a *.svg wildcard (“dir/*” will only include the *.svg files in dir). Defaults to the current working directory.

out, -o

The output path for the generated output file (CSS, SASS…). The directory will be created if it does not already exist. Defaults to the ‘out’ directory in the current working directory.

out-sprite, -s

The output path for the SVG and PNG sprites. The directory will be created if it does not already exist. Defaults to the ‘sprites’ directory in the output directory.

out-icons

The output path for the optimized SVG and rasterized PNG individual icons. If left blank, no icons will be generated. If defined, a supplementary output file will be generated with a ‘-icons’ suffix. Defaults to blank (no icons generated).

render, -r

How the output should be rendered. Can be:

• css: for CSS output [default]

• scss: for SASS output

• no or Falsy from python: no output (to simply generate the sprite)

• a path to a custom Jinja2 template file for a 100% custom output (see existing templates for available variables)

static-url

The absolute URL to the static directory. Used for links towards sprites and icons files from within the generated outputs. Defaults to /static

sprites-url

The absolute or relative (to static-url) URL to the sprites directory. Used for links towards sprite files. Defaults to sprites

icons-url

The absolute or relative (to static-url) URL to the icons directory. Used for links towards individual icons. Not used if out-icons is not defined. Defaults to icons

padding

Padding around the icons, in pixels. Defaults to 0.

layout

The sprite layout. Can be vertical, horizontal or diagonal. Defaults to vertical.

png

Should png fallbacks be generated? If True, PNG sprites will be generated and used by any icon bearing a ‘nosvg’ class. Defaults to True

data

Should SVG and PNG images be linked as dataURIs? Remember that a page loads faster (thanks to caching vs dataURI decoding) if the CSS does not use dataURIs. Defaults to False

class

A common CSS class for all the icons in the sprite. Default to None.

selectors

Comma-separated list of selectors that can be embedded in icons filenames, using the _ separator. For example, there a file name_hover.svg will be taken as the hovered version of the icon name. Defaults to hover,target,active

scour-*

All the options from scour, using the ‘scour-’ prefix. ‘strip-xml-prolog’ becomes ‘scour-strip-xml-prolog’ Defaults to best possible optimisation parameters for sprite generation.