Sources

class bkgen.source.Source(fn=None, data=None, **args)

Bases: bl.file.File

Base class/mixin for supported source formats. All sources must have the following properties and methods.

fn

the filesystem path (filename) of the source, or None

write()

to write the source to the filesystem

documents()

returns a list of XML documents, with the root element tag pub:document, from the Source.

images()

returns a list of bf.image.Image objects provided by the Source.

metadata()

returns a bkgen.metadata.Metadata object provided by the Source, or None.

stylesheet()

returns a bkgen.css.CSS stylesheet object provided by the Source, or None.