keep-it-secret/docs/source/ext.rst

Extensions
==========

.. module:: keep_it_secret.ext

This section provides documentation for built-in extensions for Keep It Secret.

AWS Secrets Manager Wrapper
---------------------------

**Installation**

Since AWS extension has external dependencies it needs to be explicitly named
to be installed:

.. code-block:: shell

    $ pip install keep_it_secret[aws]

**API**

.. autoclass:: keep_it_secret.ext.aws.AWSSecrets
    :members:

.. autoclass:: keep_it_secret.ext.aws.AWSSecretsManagerField
    :members:

Hashicorp Vault Wrapper
-----------------------

**Installation**

Since Vault extension has external dependencies it needs to be explicitly named
to be installed:

.. code-block:: shell

    $ pip install keep_it_secret[vault]

**API**

.. autoclass:: keep_it_secret.ext.vault.VaultSecrets
    :members:

.. autoclass:: keep_it_secret.ext.vault.VaultKV2Field
    :members:

Basic secrets loader
--------------------

.. autofunction:: keep_it_secret.ext.loader.load_secrets