:orphan:

:py:mod:`vendor_fabric.secrets_sync._binding`
=============================================

.. py:module:: vendor_fabric.secrets_sync._binding

.. autodoc2-docstring:: vendor_fabric.secrets_sync._binding
   :parser: myst
   :allowtitles:

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

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`load_binding <vendor_fabric.secrets_sync._binding.load_binding>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.load_binding
          :parser: myst
          :summary:
   * - :py:obj:`is_binding_available <vendor_fabric.secrets_sync._binding.is_binding_available>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.is_binding_available
          :parser: myst
          :summary:
   * - :py:obj:`validate_config <vendor_fabric.secrets_sync._binding.validate_config>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.validate_config
          :parser: myst
          :summary:
   * - :py:obj:`get_config_info <vendor_fabric.secrets_sync._binding.get_config_info>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.get_config_info
          :parser: myst
          :summary:
   * - :py:obj:`run_pipeline <vendor_fabric.secrets_sync._binding.run_pipeline>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.run_pipeline
          :parser: myst
          :summary:
   * - :py:obj:`dry_run <vendor_fabric.secrets_sync._binding.dry_run>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.dry_run
          :parser: myst
          :summary:
   * - :py:obj:`get_targets <vendor_fabric.secrets_sync._binding.get_targets>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.get_targets
          :parser: myst
          :summary:
   * - :py:obj:`get_sources <vendor_fabric.secrets_sync._binding.get_sources>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.get_sources
          :parser: myst
          :summary:
   * - :py:obj:`merge <vendor_fabric.secrets_sync._binding.merge>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.merge
          :parser: myst
          :summary:
   * - :py:obj:`sync <vendor_fabric.secrets_sync._binding.sync>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.sync
          :parser: myst
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`BINDING_MODULE <vendor_fabric.secrets_sync._binding.BINDING_MODULE>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.BINDING_MODULE
          :parser: myst
          :summary:
   * - :py:obj:`BINDING_INSTALL_GUIDANCE <vendor_fabric.secrets_sync._binding.BINDING_INSTALL_GUIDANCE>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.BINDING_INSTALL_GUIDANCE
          :parser: myst
          :summary:

API
~~~

.. py:data:: BINDING_MODULE
   :canonical: vendor_fabric.secrets_sync._binding.BINDING_MODULE
   :value: 'secrets_sync'

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.BINDING_MODULE
      :parser: myst

.. py:data:: BINDING_INSTALL_GUIDANCE
   :canonical: vendor_fabric.secrets_sync._binding.BINDING_INSTALL_GUIDANCE
   :value: 'SecretSync Python bindings are required for pipeline execution. Install secrets-sync-python-binding ...'

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.BINDING_INSTALL_GUIDANCE
      :parser: myst

.. py:function:: load_binding() -> typing.Any
   :canonical: vendor_fabric.secrets_sync._binding.load_binding

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.load_binding
      :parser: myst

.. py:function:: is_binding_available() -> bool
   :canonical: vendor_fabric.secrets_sync._binding.is_binding_available

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.is_binding_available
      :parser: myst

.. py:function:: validate_config(config_path: str) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync._binding.validate_config

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.validate_config
      :parser: myst

.. py:function:: get_config_info(config_path: str) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync._binding.get_config_info

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.get_config_info
      :parser: myst

.. py:function:: run_pipeline(config_path: str, options: vendor_fabric.secrets_sync.models.SyncOptions | None = None, provider_session: vendor_fabric.secrets_sync.models.ProviderSession | collections.abc.Mapping[str, typing.Any] | None = None) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync._binding.run_pipeline

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.run_pipeline
      :parser: myst

.. py:function:: dry_run(config_path: str, provider_session: vendor_fabric.secrets_sync.models.ProviderSession | collections.abc.Mapping[str, typing.Any] | None = None) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync._binding.dry_run

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.dry_run
      :parser: myst

.. py:function:: get_targets(config_path: str) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync._binding.get_targets

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.get_targets
      :parser: myst

.. py:function:: get_sources(config_path: str) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync._binding.get_sources

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.get_sources
      :parser: myst

.. py:function:: merge(config_path: str, *, dry_run: bool = False, provider_session: vendor_fabric.secrets_sync.models.ProviderSession | collections.abc.Mapping[str, typing.Any] | None = None) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync._binding.merge

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.merge
      :parser: myst

.. py:function:: sync(config_path: str, *, dry_run: bool = False, provider_session: vendor_fabric.secrets_sync.models.ProviderSession | collections.abc.Mapping[str, typing.Any] | None = None) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync._binding.sync

   .. autodoc2-docstring:: vendor_fabric.secrets_sync._binding.sync
      :parser: myst