synapse.tools.storm.pkg package

Submodules

synapse.tools.storm.pkg.doc module

async synapse.tools.storm.pkg.doc.buildPkgDocs(outp, pkgpath: str, rst_only: bool = False)[source]
synapse.tools.storm.pkg.doc.hasPandoc()[source]
async synapse.tools.storm.pkg.doc.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.storm.pkg.gen module

synapse.tools.storm.pkg.gen.getStormStr(fn)[source]
synapse.tools.storm.pkg.gen.loadOpticFiles(pkgdef, path)[source]
synapse.tools.storm.pkg.gen.loadOpticWorkflows(pkgdef, path)[source]
synapse.tools.storm.pkg.gen.loadPkgProto(path, opticdir=None, no_docs=False, readonly=False)[source]

Get a Storm Package definition from disk.

Parameters:

  • path (str) – Path to the package .yaml file on disk.

  • opticdir (str) – Path to optional Optic module code to add to the Storm Package.

  • no_docs (bool) – If true, omit inline documentation content if it is not present on disk.

  • readonly (bool) – If set, open files in read-only mode. If files are missing, that will raise a NoSuchFile exception.

Returns:

A Storm package definition.

Return type:

dict

async synapse.tools.storm.pkg.gen.main(argv, outp=<synapse.lib.output.OutPut object>)[source]
synapse.tools.storm.pkg.gen.tryLoadPkgProto(fp, opticdir=None, readonly=False)[source]

Try to get a Storm Package prototype from disk with or without inline documentation.

Parameters:

  • fp (str) – Path to the package .yaml file on disk.

  • opticdir (str) – Path to optional Optic module code to add to the Storm Package.

  • readonly (bool) – If set, open files in read-only mode. If files are missing, that will raise a NoSuchFile exception.

Returns:

A Storm package definition.

Return type:

dict