Skip to content

Add Support for Configuration via Environment Variables #1

Description

@saibot07

Description

Currently, python_repo_boost relies entirely on specifying configuration values via a settings file or command-line arguments. For better flexibility and to adapt to modern deployment practices (e.g., Docker and cloud environments), it would be a great enhancement to allow configuration via environment variables.

Proposed Solution

  • Extend the configuration loader to check for environment variables as a fallback mechanism if certain configuration options are not specified in the settings file.
  • Define a clear mapping between environment variable names and the configuration options.

Example

For instance, if the settings file has an option api_key, we can map this to an environment variable PYTHON_REPO_BOOST_API_KEY.

Benefits

  • Simplifies configuration for cloud-based deployments.
  • Enhances security practices by allowing sensitive data (e.g., API keys) to be handled via environment variables rather than being stored in code or files.

To Do

  • Discuss and finalize naming conventions for the environment variables.
  • Update the documentation to reflect these changes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions