Modules reference¶
satnogsconfig
¶
SatNOGS Config module initialization
satnogsconfig.config
¶
Configuration module
- class satnogsconfig.config.Config(filename)[source]¶
Manage configuration file
- Parameters
filename (str) – File path of configuration
- _load_config()[source]¶
Load and parse YAML configuration
- Returns
Configuration dictionary
- Return type
dict or NoneType
- dump_config(to_file=False)[source]¶
Dump configuration in YAML format
- Parameters
to_file (bool, optional) – Dump to file
- Returns
YAML configuration
- Return type
str
satnogsconfig.helpers
¶
Helpers module
- class satnogsconfig.helpers.Ansible(ansible_dir)[source]¶
Call Ansible playbooks
- pull(playbooks, url, branch=None, tags=None, extra_args=None)[source]¶
Pull and run Ansible playbook
- Parameters
playbooks (list) – List of playbooks
url (str) – Git URL to pull playbooks
branch (str, optional) – Git branch to pull playbooks
tags (list, optional) – List of tags
extra_args (list, optional) – List of extra arguments to pass to Ansible
- Returns
Whether Ansible execution succeeded
- Return type
bool
- class satnogsconfig.helpers.GrSatnogs[source]¶
Get and set gr-satnogs configuration
- property gr_satnogs_version¶
Get gr-satnogs version
- class satnogsconfig.helpers.SatnogsSetup[source]¶
Interract with satnogs-setup
- property gnuradio_version¶
Get installed gnuradio version
- Returns
Version of gr-soapy
- Return type
str
- property gr_satnogs_version¶
Get installed gr-satnogs version
- Returns
Version of gr-satnogs
- Return type
str
- property gr_soapy_version¶
Get installed gr-soapy version
- Returns
Version of gr-soapy
- Return type
str
- property is_applied¶
Check whether configuration has been applied
- Returns
Whether configuration has been applied
- Return type
bool
- static restart(boot=False)[source]¶
Restart satnogs-setup script
- Parameters
boot (bool, optional) – Whether to bootstrap or not
- property satnogs_client_ansible_version¶
Get installed SatNOGS Client Ansible version
- Returns
Version of SatNOGS Client Ansible
- Return type
str
- property satnogs_client_version¶
Get installed SatNOGS Client version
- Returns
Version of SatNOGS Client
- Return type
str
- property satnogs_flowgraphs_version¶
Get installed satnogs-flowgraphs version
- Returns
Version of satnogs-flowgraphs
- Return type
str
- property tags¶
Get satnogs-setup tags
- Returns
Set of tags
- Return type
set
- class satnogsconfig.helpers.Support(config, satnogs_setup, ansible)[source]¶
Create support information to be used for reporting bugs
- dump(*args, **kwargs)[source]¶
Dump support information
- Returns
JSON dump of support information
- Return type
str
- property info¶
Support information
- Returns
Support information dictionary
- Return type
dict