2.1. wc_sandbox package

2.1.2. Submodules

2.1.3. wc_sandbox.__main__ module

wc_sandbox command line interface

Author:Jonathan Karr <karr@mssm.edu>
Date:2019-02-08
Copyright:2019, Karr Lab
License:MIT
class wc_sandbox.__main__.App(label=None, **kw)[source]

Bases: cement.core.foundation.App

Command line application

class Meta[source]

Bases: object

base_controller = 'base'[source]
handlers = [<class 'wc_sandbox.__main__.BaseController'>, <class 'wc_sandbox.__main__.InstallPackages'>, <class 'wc_sandbox.__main__.GetNotebooks'>, <class 'wc_sandbox.__main__.StartController'>][source]
label = 'wc-sandbox'[source]
class wc_sandbox.__main__.BaseController(*args, **kw)[source]

Bases: cement.ext.ext_argparse.ArgparseController

Base controller for command line application

class Meta[source]

Bases: object

arguments = [(['-v', '--version'], {'action': 'version', 'version': '0.0.1'})][source]
description = 'wc-sandbox'[source]
label = 'base'[source]
class wc_sandbox.__main__.GetNotebooks(*args, **kw)[source]

Bases: cement.ext.ext_argparse.ArgparseController

Get notebooks from WC packages

class Meta[source]

Bases: object

arguments = [][source]
description = 'Get notebooks'[source]
label = 'get-notebooks'[source]
stacked_on = 'base'[source]
stacked_type = 'nested'[source]
class wc_sandbox.__main__.InstallPackages(*args, **kw)[source]

Bases: cement.ext.ext_argparse.ArgparseController

Install WC packages

class Meta[source]

Bases: object

arguments = [][source]
description = 'Install packages'[source]
label = 'install-packages'[source]
stacked_on = 'base'[source]
stacked_type = 'nested'[source]
class wc_sandbox.__main__.StartController(*args, **kw)[source]

Bases: cement.ext.ext_argparse.ArgparseController

Start server

class Meta[source]

Bases: object

arguments = [(['--allow-root'], {'action': 'store_true', 'default': False, 'help': 'Allow the notebook to be run from root user.'}), (['--ip'], {'type': <class 'str'>, 'default': '*', 'help': 'IP address the notebook server will listen on.'}), (['--port'], {'type': <class 'int'>, 'default': None, 'help': 'Port the notebook server will listen on.'}), (['--no-browser'], {'action': 'store_true', 'default': False, 'help': "Don't open the notebook in a browser after startup."})][source]
description = 'Start server'[source]
label = 'start'[source]
stacked_on = 'base'[source]
stacked_type = 'nested'[source]
wc_sandbox.__main__.main()[source]

2.1.4. Module contents