Python项目Github分享时隐藏API Key并兼容Streamlit部署方案咨询

本地开发阶段 #

• 项目根目录新建.env文件，写入API密钥：

  API_KEY=你的真实API密钥
  

• 编辑.gitignore，加入.env，阻止该文件提交到GitHub：

  .env
  

• 用python-dotenv读取环境变量：
  先安装依赖：

  pip install python-dotenv
  

  代码中调用：

  from dotenv import load_dotenv
  import os
  
  load_dotenv()
  api_key = os.getenv("API_KEY")
  

Streamlit部署阶段 #

• 登录Streamlit Cloud，打开目标项目的Settings页面
• 找到Secrets板块，在输入框中按.env格式添加密钥：

  API_KEY=你的真实API密钥
  

• 保存设置后重新部署项目，Streamlit会自动加载这些密钥，代码中os.getenv("API_KEY")的逻辑无需修改

关键注意点 #

• 代码中绝对不能硬编码API密钥，全部通过环境变量获取
• 本地先测试通过.env读取密钥的逻辑，确保无错误再部署
• Streamlit Secrets是项目级私有配置，不会对外泄露

内容的提问来源于stack exchange，提问作者oguzenveruzan