Developer guide¶
Installation¶
To install SatNOGS Config for development run in the project root directory:
$ pip install -e .
Configuration¶
This project uses python-dotenv
.
Configuration of satnogsconfig/settings.py
can be overridden by setting the respective environment variables or an .env
file placed on the project root directory.
Extending¶
SatNOGS Config functionality can be extended by implementing additional helpers. The helpers are used to enhance menu functionality beyond the core function of generating a YAML file for Ansible.
Code Quality Assurance¶
The following code quality assurance tools are used in this project:
flake8
isort
yapf
pylint
Automation¶
tox
is used to automate development tasks.
To execute the default list of tasks run:
$ tox