From c46325605897effba87dafce888ebda8c8b200fa Mon Sep 17 00:00:00 2001 From: Daniel Hougaard <62331820+DanielHougaard@users.noreply.github.com> Date: Sun, 24 Dec 2023 17:11:08 +0400 Subject: [PATCH] Updated Python docs --- docs/sdks/languages/python.mdx | 60 ++++++++++++++++++++++------------ 1 file changed, 40 insertions(+), 20 deletions(-) diff --git a/docs/sdks/languages/python.mdx b/docs/sdks/languages/python.mdx index e8c4a90c6..0a7ad3ef6 100644 --- a/docs/sdks/languages/python.mdx +++ b/docs/sdks/languages/python.mdx @@ -62,24 +62,40 @@ client = InfisicalClient(ClientSettings( ### Parameters - - Your Infisical Client ID. - - - Your Infisical Client Secret. - - - If you want to directly pass an access token obtained from the authentication endpoints, you can do so. - - - Your self-hosted absolute site URL including the protocol (e.g. - `https://app.infisical.com`) - + + + + Your Infisical Client ID. + + + Your Infisical Client Secret. + + + If you want to directly pass an access token obtained from the authentication endpoints, you can do so. + + + + Time-to-live (in seconds) for refreshing cached secrets. + If manually set to 0, caching will be disabled, this is not recommended. + + + + + Your self-hosted absolute site URL including the protocol (e.g. + `https://app.infisical.com`) + + + + + +### Caching + +The SDK caches every secret and updates it periodically based on the provided cacheTTL. For example, if cacheTTL of 300 is provided, then a secret will be refetched every 5 minutes. The SDK first attempts to return the cached secret, but if no secret is found it'll make a request to get the fresh secret. Every time the secret is fetched from the cache, the cached secret expiry is reset. ## Working with Secrets @@ -109,7 +125,11 @@ Retrieve all secrets within the Infisical project and environment that client is The path from where secrets should be fetched from. - + + Whether or not to set the fetched secrets to the process environment. If true, you can access the secrets like so `process.env["SECRET_NAME"]`. + + + Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference) @@ -148,7 +168,7 @@ By default, `getSecret()` fetches and returns a shared secret. If not found, it The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "personal". - + Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)