spirepy.cli¶

Submodules¶

Functions¶

`download`(item, target, output)	Dowload data from a SPIRE item.
`view`(item, target)	View a SPIRE item.
`main`()

Package Contents¶

spirepy.cli.download(item: spirepy.study.Study | spirepy.sample.Sample, target: str, output: str)[source]¶

Dowload data from a SPIRE item.

Parameters:

item (spirepy.sample.Sample or spirepy.study.Study) – The item to be viewed (spirepy.sample.Sample or spirepy.study.Study).
target (str) – What you want to view (metadata, antibiotic resistance annotations, manifest)
output (str) – The output folder where the items will be downloaded.

spirepy.cli.view(item: spirepy.study.Study | spirepy.sample.Sample, target: str)[source]¶

View a SPIRE item.

Parameters:

item (spirepy.sample.Sample or spirepy.study.Study) – The item to be viewed (spirepy.sample.Sample or spirepy.study.Study).
target (str) – What you want to view (metadata, antibiotic resistance annotations, manifest)

spirepy.cli.main()[source]¶