nest.renderer package

Submodules

nest.renderer.base_renderer module

class nest.renderer.base_renderer.baseRenderer

Bases: object

addHeading(level, text)

Add a header to the document in question.

Parameters:

  • level – Header Level

  • text – Title of the Header

addImage(imagePath, caption)

Add image to the document in question.

Parameters:

  • imagePath – Path to the image in question

  • caption – Image Caption

addPageBreak()

Add page break to the document in question.

addPlot(figureHandle)

Add figure to the document in question.

Parameters:

figureHandle – Matplotlib figure handle to add to the document

addSectionPage(text)

Add a section page to the document in question.

Parameters:

text – Title of the section

addTable(table)

Add table to the document in question.

Parameters:

table – Table to be added

addTableFromDict(data)

Add a table from a dictionary structure

addText(text)

Add text to the document in question.

Parameters:

text – Text to be added

render()

Save the document to disk.

nest.renderer.pandoc_renderer module

class nest.renderer.pandoc_renderer.pandocHTML(filename, name, options)

Bases: pandocPdf

render()

Save the document to disk.

class nest.renderer.pandoc_renderer.pandocPdf(filename, name, options)

Bases: baseRenderer

addHeading(level, text)

Add a header to the document in question.

Parameters:

  • level – Header Level

  • text – Title of the Header

addImage(imagePath, caption='')

Add image to the document in question.

Parameters:

  • imagePath – Path to the image in question

  • caption – Image Caption

addImageWidth(imagePath, width, caption='')

Add image to the document in question.

Parameters:

  • imagePath – Path to the image in question

  • width – Width of image

  • caption – Image Caption

addPageBreak()

Add page break to the document in question.

addPlot(figureHandle)

Add figure to the document in question.

Parameters:

figureHandle – Matplotlib figure handle to add to the document

addSectionPage(title)

Add a section page to the document in question.

Parameters:

text – Title of the section

addTable(text)

Add table to the document in question.

Parameters:

table – Table to be added

addTableFromDict(data, options={})

Add a table from a dictionary structure

addText(text)

Add text to the document in question.

Parameters:

text – Text to be added

render()

Save the document to disk.

nest.renderer.reportlab_renderer module

class nest.renderer.reportlab_renderer.reportlabRenderer(filename, name, options)

Bases: baseRenderer

addHeading(level, text)

Add a header to the document in question.

Parameters:

  • level – Header Level

  • text – Title of the Header

addPageBreak()

Add page break to the document in question.

addPlot(figureHandle)

Add figure to the document in question.

Parameters:

figureHandle – Matplotlib figure handle to add to the document

addSectionPage(text)

Add a section page to the document in question.

Parameters:

text – Title of the section

addTable(text)

Add table to the document in question.

Parameters:

table – Table to be added

addTableFromDict(data, options={})

Add a table from a dictionary structure

addText(text)

Add text to the document in question.

Parameters:

text – Text to be added

render()

Save the document to disk.

Module contents