Description:
Currently, there is no streamlined way to manage environment variables (such as OpenAI API key) within the project. To improve configuration management and user experience, it is probably worthwhile integrating python-dotenv (or something like that) for handling environment variables
Proposal
- Add
python-dotenv as a dependency in the project.
- Create an editable
.env.template file in the root directory.
- Add an instruction on how to customize the
.env.template file in the README.
- Update the codebase to load environment variables from the
.env file either automatically or manually.
- Edit the
.gitignore file to prevent users from committing the .env file to the remote repository.
Goals
- Simplifies configuration management.
- Improves workflows by enabling end-users to manage environment-specific variables easily.