# Python: module skeinforge_application.skeinforge_plugins.analyze_plugins.synopsis

skeinforge_application.skeinforge_plugins.analyze_plugins.synopsis ($Date: 2008/21/04 $) | index /home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/analyze_plugins/synopsis.py

Previous / Next / Contents

`
Synopsis is an analyze plugin to export the profile from a skeinforge gcode file as a csv or zip file.
The synopsis manual page is at:
http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Synopsis
Operation
Settings
Export Profile As CSV File
Export Profile As Zip File
Examples
`

## Operation

The default 'Activate Synopsis' checkbox is off. When it is on, the functions described below will work when called from the skeinforge toolchain, when it is off, the functions will not be called from the toolchain. The functions will still be called, whether or not the 'Activate Synopsis' checkbox is on, when synopsis is run directly.

## Settings

### Export Profile As CSV File

Default is on.
If 'Export Profile As CSV File' is selected, the profile from a skeinforge gcode file with comments will be exported as a csv (comma separated values) file.

### Export Profile As Zip File

Default is off.
If 'Export Profile As Zip File' is selected, the profile from a skeinforge gcode file with comments will be exported as a zip file.

## Examples

Below are examples of synopsis being used. These examples are run in a terminal in the folder which contains Screw Holder_penultimate.gcode and synopsis.py.
> python synopsis.py
This brings up the synopsis dialog.
> python synopsis.py Screw Holder_penultimate.gcode
The synopsis file is saved as Screw_Holder_penultimate_synopsis.csv

Previous / Next / Contents

Modules

``

__init__ fabmetheus_utilities.archive fabmetheus_utilities.euclidean | fabmetheus_utilities.gcodec os fabmetheus_utilities.settings | skeinforge_application.skeinforge_utilities.skeinforge_polyfile skeinforge_application.skeinforge_utilities.skeinforge_profile sys | time zipfile

Classes

``

AbridgedSetting
FileNamePath
SynopsisRepository

class AbridgedSetting
`` | `A class to handle an abridged setting.`

Methods defined here:

__init__(self, splitLine)
  `Initialize.`

__repr__(self)
  `Get the tab separated representation of this AbridgedSetting.`

class FileNamePath
`` | `A class to handle a file name and path.`

Methods defined here:

__init__(self, directoryName, fileName)
  `Initialize.`

__repr__(self)
  `Get the tab separated representation of this FileNamePath.`

class SynopsisRepository
`` | `A class to handle the synopsis settings.`

Methods defined here:

__init__(self)
  `Set the default settings, execute title & settings fileName.`

execute(self)
  `Write button has been clicked.`

Functions

``

addAbridgedSettings(abridgedSettings, repositoryWriter)
  `Add the abridged settings to a repository writer.`

exportProfileAsCSVFile(abridgedSettings, suffixFileNameWithoutExtension)
  `Export the profile from the gcode text as a csv file.`

exportProfileAsZipFile(abridgedSettings, suffixDirectoryPath, suffixFileNameWithoutExtension)
  `Export the profile from the gcode text as a zip file.`

getAbridgedSettings(gcodeText)
  `Get the abridged settings from the gcode text.`

getNewRepository()
  `Get new repository.`

getWindowAnalyzeFile(fileName)
  `Write scalable vector graphics for a gcode file.`

getWindowAnalyzeFileGivenText(fileName, gcodeText, repository=None)
  `Write scalable vector graphics for a gcode file given the settings.`

main()
  `Display the synopsis dialog.`

writeOutput(fileName, fileNamePenultimate, fileNameSuffix, filePenultimateWritten, gcodeText='')
  `Write scalable vector graphics for a skeinforge gcode file, if activate synopsis is selected.`

Data
`` |  | __author__ = 'Enrique Perez (perez_enrique@yahoo.com)' __credits__ = 'Gary Hodgson <http://garyhodgson.com/reprap/2011/06/hacking-skeinforge-export-module/>' __date__ = '$Date: 2008/21/04 $' __license__ = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html' absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)

Author
`` |  | Enrique Perez (perez_enrique@yahoo.com)

Credits
`` |  | Gary Hodgson <http://garyhodgson.com/reprap/2011/06/hacking-skeinforge-export-module/>