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

.. py:module:: vendor_fabric.secrets_sync.stores

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

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

Classes
~~~~~~~

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

   * - :py:obj:`WriteSummary <vendor_fabric.secrets_sync.stores.WriteSummary>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.WriteSummary
          :parser: myst
          :summary:
   * - :py:obj:`SecretTreeStore <vendor_fabric.secrets_sync.stores.SecretTreeStore>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.SecretTreeStore
          :parser: myst
          :summary:
   * - :py:obj:`InMemorySecretStore <vendor_fabric.secrets_sync.stores.InMemorySecretStore>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.InMemorySecretStore
          :parser: myst
          :summary:
   * - :py:obj:`VaultSecretStore <vendor_fabric.secrets_sync.stores.VaultSecretStore>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.VaultSecretStore
          :parser: myst
          :summary:
   * - :py:obj:`AWSSecretsManagerStore <vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore
          :parser: myst
          :summary:
   * - :py:obj:`S3SecretStore <vendor_fabric.secrets_sync.stores.S3SecretStore>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.S3SecretStore
          :parser: myst
          :summary:
   * - :py:obj:`StoreRegistry <vendor_fabric.secrets_sync.stores.StoreRegistry>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.StoreRegistry
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`join_secret_path <vendor_fabric.secrets_sync.stores.join_secret_path>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.join_secret_path
          :parser: myst
          :summary:
   * - :py:obj:`relative_secret_path <vendor_fabric.secrets_sync.stores.relative_secret_path>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.relative_secret_path
          :parser: myst
          :summary:
   * - :py:obj:`normalize_secret_payload <vendor_fabric.secrets_sync.stores.normalize_secret_payload>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.normalize_secret_payload
          :parser: myst
          :summary:

Data
~~~~

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

   * - :py:obj:`SecretPayload <vendor_fabric.secrets_sync.stores.SecretPayload>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.SecretPayload
          :parser: myst
          :summary:
   * - :py:obj:`SecretTree <vendor_fabric.secrets_sync.stores.SecretTree>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.SecretTree
          :parser: myst
          :summary:

API
~~~

.. py:data:: SecretPayload
   :canonical: vendor_fabric.secrets_sync.stores.SecretPayload
   :value: None

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.SecretPayload
      :parser: myst

.. py:data:: SecretTree
   :canonical: vendor_fabric.secrets_sync.stores.SecretTree
   :value: None

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.SecretTree
      :parser: myst

.. py:class:: WriteSummary
   :canonical: vendor_fabric.secrets_sync.stores.WriteSummary

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.WriteSummary
      :parser: myst

   .. py:attribute:: processed
      :canonical: vendor_fabric.secrets_sync.stores.WriteSummary.processed
      :type: int
      :value: 0

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.WriteSummary.processed
         :parser: myst

   .. py:attribute:: added
      :canonical: vendor_fabric.secrets_sync.stores.WriteSummary.added
      :type: int
      :value: 0

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.WriteSummary.added
         :parser: myst

   .. py:attribute:: modified
      :canonical: vendor_fabric.secrets_sync.stores.WriteSummary.modified
      :type: int
      :value: 0

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.WriteSummary.modified
         :parser: myst

   .. py:attribute:: removed
      :canonical: vendor_fabric.secrets_sync.stores.WriteSummary.removed
      :type: int
      :value: 0

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.WriteSummary.removed
         :parser: myst

   .. py:attribute:: unchanged
      :canonical: vendor_fabric.secrets_sync.stores.WriteSummary.unchanged
      :type: int
      :value: 0

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.WriteSummary.unchanged
         :parser: myst

.. py:class:: SecretTreeStore
   :canonical: vendor_fabric.secrets_sync.stores.SecretTreeStore

   Bases: :py:obj:`typing.Protocol`

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.SecretTreeStore
      :parser: myst

   .. py:method:: read_tree(root: str = '') -> vendor_fabric.secrets_sync.stores.SecretTree
      :canonical: vendor_fabric.secrets_sync.stores.SecretTreeStore.read_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.SecretTreeStore.read_tree
         :parser: myst

   .. py:method:: write_tree(secrets: collections.abc.Mapping[str, collections.abc.Mapping[str, typing.Any]], root: str = '', *, dry_run: bool = False) -> vendor_fabric.secrets_sync.stores.WriteSummary
      :canonical: vendor_fabric.secrets_sync.stores.SecretTreeStore.write_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.SecretTreeStore.write_tree
         :parser: myst

.. py:function:: join_secret_path(*parts: str) -> str
   :canonical: vendor_fabric.secrets_sync.stores.join_secret_path

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.join_secret_path
      :parser: myst

.. py:function:: relative_secret_path(path: str, root: str) -> str
   :canonical: vendor_fabric.secrets_sync.stores.relative_secret_path

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.relative_secret_path
      :parser: myst

.. py:function:: normalize_secret_payload(value: typing.Any) -> vendor_fabric.secrets_sync.stores.SecretPayload
   :canonical: vendor_fabric.secrets_sync.stores.normalize_secret_payload

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.normalize_secret_payload
      :parser: myst

.. py:class:: InMemorySecretStore(secrets: collections.abc.Mapping[str, collections.abc.Mapping[str, typing.Any]] | None = None)
   :canonical: vendor_fabric.secrets_sync.stores.InMemorySecretStore

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.InMemorySecretStore
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.InMemorySecretStore.__init__
      :parser: myst

   .. py:method:: read_tree(root: str = '') -> vendor_fabric.secrets_sync.stores.SecretTree
      :canonical: vendor_fabric.secrets_sync.stores.InMemorySecretStore.read_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.InMemorySecretStore.read_tree
         :parser: myst

   .. py:method:: write_tree(secrets: collections.abc.Mapping[str, collections.abc.Mapping[str, typing.Any]], root: str = '', *, dry_run: bool = False) -> vendor_fabric.secrets_sync.stores.WriteSummary
      :canonical: vendor_fabric.secrets_sync.stores.InMemorySecretStore.write_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.InMemorySecretStore.write_tree
         :parser: myst

.. py:class:: VaultSecretStore(connector: vendor_fabric.vault.VaultConnector | None = None, *, mount: str = 'secret')
   :canonical: vendor_fabric.secrets_sync.stores.VaultSecretStore

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.VaultSecretStore
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.VaultSecretStore.__init__
      :parser: myst

   .. py:method:: read_tree(root: str = '') -> vendor_fabric.secrets_sync.stores.SecretTree
      :canonical: vendor_fabric.secrets_sync.stores.VaultSecretStore.read_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.VaultSecretStore.read_tree
         :parser: myst

   .. py:method:: write_tree(secrets: collections.abc.Mapping[str, collections.abc.Mapping[str, typing.Any]], root: str = '', *, dry_run: bool = False) -> vendor_fabric.secrets_sync.stores.WriteSummary
      :canonical: vendor_fabric.secrets_sync.stores.VaultSecretStore.write_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.VaultSecretStore.write_tree
         :parser: myst

.. py:class:: AWSSecretsManagerStore(connector: vendor_fabric.aws.AWSConnector | None = None, *, prefix: str = '', execution_role_arn: str | None = None, role_session_name: str | None = None)
   :canonical: vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore.__init__
      :parser: myst

   .. py:method:: read_tree(root: str = '') -> vendor_fabric.secrets_sync.stores.SecretTree
      :canonical: vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore.read_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore.read_tree
         :parser: myst

   .. py:method:: write_tree(secrets: collections.abc.Mapping[str, collections.abc.Mapping[str, typing.Any]], root: str = '', *, dry_run: bool = False) -> vendor_fabric.secrets_sync.stores.WriteSummary
      :canonical: vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore.write_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.AWSSecretsManagerStore.write_tree
         :parser: myst

.. py:class:: S3SecretStore(connector: vendor_fabric.aws.AWSConnector | None = None, *, bucket: str, prefix: str = 'secrets-sync', execution_role_arn: str | None = None)
   :canonical: vendor_fabric.secrets_sync.stores.S3SecretStore

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.S3SecretStore
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.S3SecretStore.__init__
      :parser: myst

   .. py:method:: read_tree(root: str = '') -> vendor_fabric.secrets_sync.stores.SecretTree
      :canonical: vendor_fabric.secrets_sync.stores.S3SecretStore.read_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.S3SecretStore.read_tree
         :parser: myst

   .. py:method:: write_tree(secrets: collections.abc.Mapping[str, collections.abc.Mapping[str, typing.Any]], root: str = '', *, dry_run: bool = False) -> vendor_fabric.secrets_sync.stores.WriteSummary
      :canonical: vendor_fabric.secrets_sync.stores.S3SecretStore.write_tree

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.S3SecretStore.write_tree
         :parser: myst

.. py:class:: StoreRegistry
   :canonical: vendor_fabric.secrets_sync.stores.StoreRegistry

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.StoreRegistry
      :parser: myst

   .. py:attribute:: sources
      :canonical: vendor_fabric.secrets_sync.stores.StoreRegistry.sources
      :type: collections.abc.MutableMapping[str, vendor_fabric.secrets_sync.stores.SecretTreeStore]
      :value: 'field(...)'

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.StoreRegistry.sources
         :parser: myst

   .. py:attribute:: targets
      :canonical: vendor_fabric.secrets_sync.stores.StoreRegistry.targets
      :type: collections.abc.MutableMapping[str, vendor_fabric.secrets_sync.stores.SecretTreeStore]
      :value: 'field(...)'

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.StoreRegistry.targets
         :parser: myst

   .. py:attribute:: merge_store
      :canonical: vendor_fabric.secrets_sync.stores.StoreRegistry.merge_store
      :type: vendor_fabric.secrets_sync.stores.SecretTreeStore | None
      :value: None

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.stores.StoreRegistry.merge_store
         :parser: myst