byoc 0.32.0

BYOC is a python library for integrating configuration values from any number/kind of sources, e.g. files, command-line arguments, environment variables, remote JSON APIs, etc. The primary goal of BYOC is to give you complete control over your configuration. This means:

• Complete control over how files, options, etc. are named and organized.

• Complete control over how values from different config sources are parsed and merged.

• Support for any kind of file format, argument parsing library, etc.

• No opinions about anything enforced by BYOC.

To use BYOC, you would create a class with special attributes (called parameters) that know where to look for configuration values. When these parameters are accessed, the desired values are looked up, possibly merged, possibly cached, and returned. Here’s a brief example:

import byoc
from byoc import Key, DocoptConfig, AppDirsConfig

class Greet(byoc.App):
    """
    Say a greeting.

    Usage:
        greet <name> [-g <greeting>]
    """

    # Define which config sources are available to this class.
    __config__ = [
            DocoptConfig,
            AppDirsConfig.setup(name='conf.yml'),
    ]

    # Define how to search for each config value.
    name = byoc.param(
            Key(DocoptConfig, '<name>'),
    )
    greeting = byoc.param(
            Key(DocoptConfig, '-g'),
            Key(AppDirsConfig, 'greeting'),
            default='Hello',
    )

    def main(self):
        self.load(DocoptConfig)
        print(f"{self.greeting}, {self.name}!")

if __name__ == '__main__':
    Greet.entry_point()

We can configure this script from the command line:

$ ./greet 'Sir Bedevere'
Hello, Sir Bedevere!
$ ./greet 'Sir Lancelot' -g Goodbye
Goodbye, Sir Lancelot!

…or from its config files:

$ mkdir -p ~/.config/greet
$ echo "greeting: Run away" > ~/.config/greet/conf.yml
$ greet 'Sir Robin'
Run away, Sir Robin!

This example only scratches the surface, but hopefully you can already get a sense for how powerful and flexible these parameters are. For more information, refer to the following examples (in lieu of complete documentation).