veoibd_synapse.cli package¶
Submodules¶
veoibd_synapse.cli.config module¶
Provide functions used in cli.config.
veoibd_synapse.cli.main module¶
Provide command line interface to the synapse manager.
veoibd_synapse.cli.pull module¶
Provide code devoted to downloading data from Synapse.
veoibd_synapse.cli.push module¶
Provide code devoted to uploading data to Synapse.
-
class
veoibd_synapse.cli.push.
BaseInteraction
(info)[source]¶ Bases:
object
Base class to manage information and execution for a single interaction with Synapse.
-
class
veoibd_synapse.cli.push.
Push
(main_confs, user, push_config)[source]¶ Bases:
object
Manage interactions with Synapse concerning adding/changing information on the Synapse servers.
-
_Push__base_info
()¶ Return a fresh basic info tree for a new interaction to update.
-
__init__
(main_confs, user, push_config)[source]¶ Initialize and validate basic information for a Push.
-
_get_remote_entity_dicts
()[source]¶ Query Synapse for all entity information related to this Project ID.
-
-
class
veoibd_synapse.cli.push.
PushInteraction
(info, push_obj)[source]¶ Bases:
veoibd_synapse.cli.push.BaseInteraction
Manage information and execution for a single “push” interaction with Synapse.
veoibd_synapse.cli.query module¶
Provide code devoted to querying Synapse.
veoibd_synapse.cli.syncdb module¶
Provide code devoted to retrieving and building the most up-to-date metadata database info from Synapse.
-
class
veoibd_synapse.cli.syncdb.
ProjectSubjectDatabase
(main_confs, syn, project_id)[source]¶ Bases:
veoibd_synapse.cli.syncdb.SubjectDatabase
Manage interactions with Synapse concerning accessing, downloading, and combining subject database files from a single Synapse Project.
-
__init__
(main_confs, syn, project_id)[source]¶ Initialize and validate basic information.
Parameters: - main_confs (dict-like) – refernce to main configuration tree.
- syn (Synapse) – an active synapse connection object.
- project_id (str) – Synapse ID for a project.
-
-
class
veoibd_synapse.cli.syncdb.
SubjectDatabase
(main_confs, syn)[source]¶ Bases:
object
Base class for managing interactions with Synapse concerning accessing, downloading, and combining subject database files from member-sites.
-
class
veoibd_synapse.cli.syncdb.
TeamSubjectDatabase
(main_confs, syn, team_name)[source]¶ Bases:
veoibd_synapse.cli.syncdb.SubjectDatabase
Manage interactions with Synapse concerning accessing, downloading, and combining subject database files from all member-sites in a Team.
-
__init__
(main_confs, syn, team_name)[source]¶ Initialize and validate basic information.
Parameters: - main_confs (dict-like) – refernce to main configuration tree.
- syn (Synapse) – an active synapse connection object.
- team_name (str) – the name of a Synapse Team.
-
build_project_dbs
()[source]¶ Iterate through project IDs building DB tables from each, storing the restults.
Stored as
ProjectSubjectDatabase
objects
-