如何在不将API密钥上传至Github的情况下与团队共享并实现快速调用？

针对你遇到的问题，这里有几个成熟的解决思路，既能避免API密钥暴露在Github，又能让团队成员快速上手：

方案1：示例配置文件+环境变量（最常用） #

这个方法简单易操作，适合小型团队：

• 提交一个config.example.py到仓库，里面写好占位符和注释，比如：

  # 请复制此文件并重命名为config.py，替换为实际API密钥
  API_KEY = "替换成你的API密钥"
  API_ENDPOINT = "https://api.example.com/v1"
  

• 在.gitignore中添加config.py，确保敏感文件不会被提交。
• 升级版：用环境变量替代硬编码。修改代码从环境变量读取密钥：

  import os
  # 从环境变量获取，没有的话用默认值（可选）
  API_KEY = os.getenv("MY_PROJECT_API_KEY")
  API_ENDPOINT = os.getenv("MY_PROJECT_API_ENDPOINT", "https://api.example.com/v1")
  

• 配合python-dotenv包，创建.env文件存储环境变量：

  MY_PROJECT_API_KEY=你的实际密钥
  MY_PROJECT_API_ENDPOINT=https://api.example.com/v1
  

  把.env加入.gitignore，然后通过团队内部聊天工具、密码管理器把.env文件的内容共享给队友，新成员拿到后放在项目根目录即可直接运行。

方案2：团队密码管理工具 #

用专门的密码管理工具统一存储和共享密钥，更安全：

• 选择Bitwarden、1Password这类支持团队共享的工具，创建一个团队共享库。
• 把API密钥作为安全笔记或自定义条目存入共享库，设置好团队成员的访问权限。
• 新成员加入团队后，登录密码管理器就能获取密钥，然后自己配置到本地的config文件或环境变量中。

方案3：加密提交敏感文件（适合需要版本控制的场景） #

如果需要对config文件进行版本控制，同时保证内容不泄露，可以用加密工具：

• 使用git-crypt：
  1. 安装git-crypt后，在仓库根目录执行git-crypt init初始化加密。
  2. 创建.gitattributes文件，指定要加密的文件：

     config.py filter=git-crypt diff=git-crypt
     

  3. 添加团队成员的GPG公钥：git-crypt add-gpg-user 队友的邮箱。
  4. 提交config.py到仓库，此时文件会被加密，Github上看不到明文。
  5. 队友克隆仓库后，用自己的GPG私钥执行git-crypt unlock就能解密文件，正常使用。

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