boss.configuration
==================

.. py:module:: boss.configuration


Classes
-------

.. autoapisummary::

   boss.configuration.Document
   boss.configuration.WorkerConfigurationDocument


Module Contents
---------------

.. py:class:: Document

   Bases: :py:obj:`dict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:method:: parse_string(s: str)
      :classmethod:


      Parse a document in JSON format from a string.

      :param s: string containing the JSON representation of the config



   .. py:method:: parse_url(url: str)
      :classmethod:


      Parse a document in JSON format from a URL.

      :param url: any URL supported by urllib (e.g. file://local.json or https://user:pass@couch.db/database/my_doc)



.. py:class:: WorkerConfigurationDocument

   Bases: :py:obj:`Document`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:method:: datasource_config()


   .. py:method:: generate_tags(boss_name)

      Add boss/configuration specific tags to the HERO.



   .. py:method:: build_hero_for_worker(boss_name: str, worker_object, realm='heros')


