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

.. py:module:: vendor_fabric.secrets_sync.pipeline

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

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

Classes
~~~~~~~

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

   * - :py:obj:`SecretSyncPipeline <vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

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

API
~~~

.. py:class:: SecretSyncPipeline(config: vendor_fabric.secrets_sync.models.SecretSyncConfig, *, stores: vendor_fabric.secrets_sync.stores.StoreRegistry | None = None, logger: extended_data.logging.Logging | None = None)
   :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.__init__
      :parser: myst

   .. py:method:: from_file(config_path: str, *, stores: vendor_fabric.secrets_sync.stores.StoreRegistry | None = None, logger: extended_data.logging.Logging | None = None) -> vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.from_file
      :classmethod:

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.from_file
         :parser: myst

   .. py:method:: run(options: vendor_fabric.secrets_sync.models.SyncOptions | None = None) -> vendor_fabric.secrets_sync.models.SyncResult
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.run

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.run
         :parser: myst

   .. py:method:: run_extended(options: vendor_fabric.secrets_sync.models.SyncOptions | None = None) -> extended_data.containers.ExtendedData
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.run_extended

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.run_extended
         :parser: myst

   .. py:method:: validate_config() -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.validate_config

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.validate_config
         :parser: myst

   .. py:method:: config_info() -> vendor_fabric.secrets_sync.models.ConfigInfo
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.config_info

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.config_info
         :parser: myst

   .. py:method:: resolve_targets(requested: list[str] | None = None) -> list[str]
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.resolve_targets

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.resolve_targets
         :parser: myst

   .. py:method:: merge_target(target_name: str, *, dry_run: bool = False) -> vendor_fabric.secrets_sync.models.OperationResult
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.merge_target

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.merge_target
         :parser: myst

   .. py:method:: sync_target(target_name: str, *, dry_run: bool = False) -> vendor_fabric.secrets_sync.models.OperationResult
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.sync_target

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.sync_target
         :parser: myst

   .. py:method:: bundle_path_for_target(target_name: str) -> str
      :canonical: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.bundle_path_for_target

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.SecretSyncPipeline.bundle_path_for_target
         :parser: myst

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

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

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

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.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.pipeline.run_pipeline

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.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.pipeline.dry_run

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

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

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

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

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.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.pipeline.merge

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.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.pipeline.sync

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

.. py:function:: diff_trees(target: str, phase: str, before: collections.abc.Mapping[str, typing.Any], after: collections.abc.Mapping[str, typing.Any]) -> vendor_fabric.secrets_sync.models.TargetDiff
   :canonical: vendor_fabric.secrets_sync.pipeline.diff_trees

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.diff_trees
      :parser: myst

.. py:function:: format_diff(diffs: list[vendor_fabric.secrets_sync.models.TargetDiff], *, output_format: vendor_fabric.secrets_sync.models.OutputFormat = OutputFormat.JSON) -> str
   :canonical: vendor_fabric.secrets_sync.pipeline.format_diff

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.pipeline.format_diff
      :parser: myst