Sangfroid

Sangfroid is a Python library to read Synfig documents, in the .sif, .sifz, and .sfg formats. It isn’t ready for general use yet.

Development happens on gitlab, but there’s also a github mirror.

Currently we’re approaching our first pre-alpha release, 0.1 liverpool.

How to install

Short answer:

• pip install . (That’s a full stop at the end.)

Long answer:

• git clone https://gitlab.com/marnanel/sangfroid.git

• cd sangfroid

• python3 -m venv venv

• . venv/bin/activate

• python -m pip install .

Get involved

• Drop by on our Discord server.

• Raise issues. We like issues.

• Post questions and suggestions on Synfig’s own forums, using the tag #sangfroid.

Contents

• Examples
• Usage
• API
  • Animation
    • Animation
      • Animation.background
      • Animation.begin_time
      • Animation.description
      • Animation.end_time
      • Animation.fps
      • Animation.keyframes
      • Animation.name
      • Animation.resolution
      • Animation.save()
      • Animation.size
      • Animation.viewbox
  • T
    • T
      • T.fps
      • T.frames
      • T.seconds
  • Layer types
    • Advanced_Outline
      • Advanced_Outline.PARAMS
      • Advanced_Outline.SYMBOL
    • Bevel
      • Bevel.PARAMS
      • Bevel.SYMBOL
    • Blur
      • Blur.PARAMS
      • Blur.SYMBOL
    • Checker_Board
      • Checker_Board.PARAMS
      • Checker_Board.SYMBOL
    • Chromakey
      • Chromakey.PARAMS
      • Chromakey.SYMBOL
    • Circle
      • Circle.PARAMS
      • Circle.SYMBOL
    • Clamp
      • Clamp.PARAMS
      • Clamp.SYMBOL
    • Colorcorrect
      • Colorcorrect.PARAMS
      • Colorcorrect.SYMBOL
    • Conical_Gradient
      • Conical_Gradient.PARAMS
      • Conical_Gradient.SYMBOL
    • Curve_Gradient
      • Curve_Gradient.PARAMS
      • Curve_Gradient.SYMBOL
    • Curve_Warp
      • Curve_Warp.PARAMS
      • Curve_Warp.SYMBOL
    • Duplicate
      • Duplicate.PARAMS
      • Duplicate.SYMBOL
    • Filter_Group
      • Filter_Group.PARAMS
      • Filter_Group.SYMBOL
    • Freetime
      • Freetime.PARAMS
      • Freetime.SYMBOL
    • Group
      • Group.PARAMS
      • Group.SYMBOL
      • Group.children
      • Group.descendants
    • Halftone2
      • Halftone2.PARAMS
      • Halftone2.SYMBOL
    • Halftone3
      • Halftone3.PARAMS
      • Halftone3.SYMBOL
    • Import
      • Import.PARAMS
      • Import.SYMBOL
    • Inside_Out
      • Inside_Out.PARAMS
      • Inside_Out.SYMBOL
    • Julia
      • Julia.PARAMS
      • Julia.SYMBOL
    • Layer
      • Layer.FIELDS_IN_TAG_ATTRIBUTES
      • Layer.SYMBOL
      • Layer.depth
      • Layer.desc
      • Layer.find()
      • Layer.find_all()
      • Layer.from_tag()
      • Layer.handles_type
      • Layer.items()
      • Layer.keys()
      • Layer.parent
      • Layer.values()
    • Linear_Gradient
      • Linear_Gradient.PARAMS
      • Linear_Gradient.SYMBOL
    • Lumakey
      • Lumakey.PARAMS
      • Lumakey.SYMBOL
    • Mandelbrot
      • Mandelbrot.PARAMS
      • Mandelbrot.SYMBOL
    • Metaballs
      • Metaballs.PARAMS
      • Metaballs.SYMBOL
    • Motion_Blur
      • Motion_Blur.PARAMS
      • Motion_Blur.SYMBOL
    • Noise
      • Noise.PARAMS
      • Noise.SYMBOL
    • Noise_Distort
      • Noise_Distort.PARAMS
      • Noise_Distort.SYMBOL
    • Outline
      • Outline.PARAMS
      • Outline.SYMBOL
    • Plant
      • Plant.PARAMS
      • Plant.SYMBOL
    • Polygon
      • Polygon.PARAMS
      • Polygon.SYMBOL
    • Radial_Blur
      • Radial_Blur.PARAMS
      • Radial_Blur.SYMBOL
    • Radial_Gradient
      • Radial_Gradient.PARAMS
      • Radial_Gradient.SYMBOL
    • Rectangle
      • Rectangle.PARAMS
      • Rectangle.SYMBOL
    • Region
      • Region.PARAMS
      • Region.SYMBOL
    • Registry
      • Registry.from_name()
    • Rotate
      • Rotate.PARAMS
      • Rotate.SYMBOL
    • Scale
      • Scale.PARAMS
      • Scale.SYMBOL
    • Shade
      • Shade.PARAMS
      • Shade.SYMBOL
    • Simple_Circle
      • Simple_Circle.PARAMS
      • Simple_Circle.SYMBOL
    • Skeleton
      • Skeleton.PARAMS
      • Skeleton.SYMBOL
    • Skeleton_Deformation
      • Skeleton_Deformation.PARAMS
      • Skeleton_Deformation.SYMBOL
    • Solid_Color
      • Solid_Color.PARAMS
      • Solid_Color.SYMBOL
    • Sound
      • Sound.PARAMS
      • Sound.SYMBOL
    • Spherize
      • Spherize.PARAMS
      • Spherize.SYMBOL
    • Spiral_Gradient
      • Spiral_Gradient.PARAMS
      • Spiral_Gradient.SYMBOL
    • Star
      • Star.PARAMS
      • Star.SYMBOL
    • Stretch
      • Stretch.PARAMS
      • Stretch.SYMBOL
    • Stroboscope
      • Stroboscope.PARAMS
      • Stroboscope.SYMBOL
    • Super_Sample
      • Super_Sample.PARAMS
      • Super_Sample.SYMBOL
    • Switch
      • Switch.PARAMS
      • Switch.SYMBOL
    • Text
      • Text.PARAMS
      • Text.SYMBOL
    • Timeloop
      • Timeloop.PARAMS
      • Timeloop.SYMBOL
    • Translate
      • Translate.PARAMS
      • Translate.SYMBOL
    • Twirl
      • Twirl.PARAMS
      • Twirl.SYMBOL
    • Value
      • Value.from_tag()
      • Value.handles_type
      • Value.is_animated
      • Value.our_type
      • Value.timeline
      • Value.value
    • Warp
      • Warp.PARAMS
      • Warp.SYMBOL
    • Xor_Pattern
      • Xor_Pattern.PARAMS
      • Xor_Pattern.SYMBOL
  • Value types
    • Angle
      • Angle.our_type
    • Bline
    • Bool
      • Bool.our_type
    • Canvas
      • Canvas.value
    • Color
      • Color.as_tuple()
      • Color.value
    • Composite
      • Composite.get()
      • Composite.items()
      • Composite.keys()
      • Composite.value
      • Composite.values()
    • Dilist
    • Dynamic_List
    • Gradient
      • Gradient.items()
      • Gradient.keys()
      • Gradient.value
      • Gradient.values()
    • Integer
      • Integer.our_type
    • Real
      • Real.our_type
    • Simple
      • Simple.our_type
      • Simple.value
    • Static_List
    • String
      • String.our_type
      • String.value
    • T
      • T.fps
      • T.frames
      • T.seconds
    • Tbd
      • Tbd.value
    • Time
      • Time.our_type
    • Value
      • Value.from_tag()
      • Value.handles_type
      • Value.is_animated
      • Value.our_type
      • Value.timeline
      • Value.value
    • Vector
      • Vector.as_tuple()
      • Vector.get()
      • Vector.items()
      • Vector.keys()
      • Vector.our_type
      • Vector.value
      • Vector.values()
    • Waypoint
      • Waypoint.after
      • Waypoint.before
      • Waypoint.from_tag()
      • Waypoint.tag
    • Wplist