Plain Text Provider¶

The Plain Text provider directly transfers values from the configuration file to the environment variables. Essentially functioning like an .env loader, it’s ideal for configuring all environment variables from a single file.

However, if you solely require an .env loader, consider exploring simpler solutions like python-dotenv.

Configuration layout¶

toml

[[sources]]
name = "typewriter"
type = "plain"

[[secrets]]
name = "FOO"
source = "typewriter"
value = "baz"

yaml

sources:
  - name: typewriter
    type: plain

secrets:
  - name: FOO
    source: typewriter
    value: bar

json

{
  "sources": [
    {
      "name": "typewriter",
      "type": "plain"
    }
  ],
  "secrets": [
    {
      "name": "FOO",
      "source": "typewriter",
      "value": "bar"
    }
  ]
}

pyproject.toml

[[tool.secrets-env.sources]]
name = "typewriter"
type = "plain"

[[tool.secrets-env.secrets]]
name = "FOO"
source = "typewriter"
value = "baz"

Source section¶

Simply set type to plain. No additional parameters are used by this provider.

Secrets section¶

Values should be placed in value field, or a string could be used directly when used in simplified mode:

toml simplified

[sources]
type = "plain"

[secrets]
FOO = "baz"

yaml simplified

sources:
  type: plain

secrets:
  FOO: bar