First Steps

Installation

Ensure you're running at least Python 3.8.0 to get the latest version of Sovereign

1
2
$ python --version
Python 3.8.2

If you haven't done so already, you can install Sovereign via pip

1
2
python -m pip install sovereign

Configuration

The main things you'll need in order to run Sovereign are:

• Sources
• Templates

Start by creating an somewhat empty YAML configuration file at the location /etc/sovereign.yaml

1
2
sources: []
templates: {}

Loadable paths

Throughout the upcoming documentation you may see references to "Loadable paths"

These are paths that Sovereign uses to dynamically include data in configuration.

They are specified in the following way:

1
2
protocol: <type of loader used>
serialization: <serializer used to decode the data>
path: <location of the data>

Most sections that ask you to use a loadable path will provide an example.

Types of loaders available

Serializations available