GitHub上Python项目的数据库凭证隐私保护方案咨询

方案1：使用系统环境变量 #

• 将数据库用户名、密码等敏感信息存入系统环境变量，代码中通过os.getenv()读取，彻底避免硬编码。
• 示例代码：

import os
import psycopg2  # 替换为你实际使用的数据库驱动

# 读取环境变量，可设置默认值降低用户配置门槛
db_user = os.getenv('DB_USER')
db_password = os.getenv('DB_PASSWORD')
db_host = os.getenv('DB_HOST', 'localhost')
db_name = os.getenv('DB_NAME', 'default_db')

# 建立数据库连接
conn = psycopg2.connect(
    user=db_user,
    password=db_password,
    host=db_host,
    database=db_name
)

• 辅助操作：
  1. 在项目根目录创建.env.example文件，列出需要的环境变量及示例值，方便用户参考配置：

  DB_USER=your_db_username
  DB_PASSWORD=your_db_password
  DB_HOST=localhost
  DB_NAME=your_db_name
  

  2. 将.env（若本地用该文件存环境变量）或任何包含真实凭证的文件加入.gitignore，防止上传到GitHub。

方案2：使用git忽略的配置文件 #

• 创建单独的配置文件存储敏感信息，将该文件加入git忽略列表，同时提供示例配置文件供用户复制修改。
• 示例步骤：
  1. 创建config.py存储真实配置：

  DB_CONFIG = {
      'user': 'your_real_username',
      'password': 'your_real_password',
      'host': 'localhost',
      'database': 'your_db_name'
  }
  

  2. 代码中导入配置：

  from config import DB_CONFIG
  import psycopg2
  
  conn = psycopg2.connect(**DB_CONFIG)
  

  3. 将config.py加入.gitignore，避免上传。
  4. 创建config.example.py示例文件并上传到GitHub：

  DB_CONFIG = {
      'user': 'your_username_here',
      'password': 'your_password_here',
      'host': 'localhost',
      'database': 'your_db_name_here'
  }
  

  用户只需复制config.example.py并重命名为config.py，填入自己的凭证即可运行。

方案3：使用python-dotenv管理环境变量 #

• 借助python-dotenv库，通过本地.env文件管理环境变量，无需手动设置系统环境变量，更适合团队协作。
• 示例步骤：
  1. 安装依赖：

  pip install python-dotenv
  

  2. 创建.env文件存储敏感信息：

  DB_USER=your_real_username
  DB_PASSWORD=your_real_password
  DB_HOST=localhost
  DB_NAME=your_db_name
  

  3. 代码中加载并使用环境变量：

  from dotenv import load_dotenv
  import os
  import psycopg2
  
  # 加载.env文件中的环境变量
  load_dotenv()
  
  db_user = os.getenv('DB_USER')
  db_password = os.getenv('DB_PASSWORD')
  db_host = os.getenv('DB_HOST')
  db_name = os.getenv('DB_NAME')
  
  conn = psycopg2.connect(
      user=db_user,
      password=db_password,
      host=db_host,
      database=db_name
  )
  

  4. 将.env加入.gitignore，上传.env.example文件供用户参考配置。

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