
本文介绍一种安全、可复用的方案,让开发者在本地运行 pip install -r requirements.txt 时,也能自动拉取私有 GitHub 仓库包,避免将 Personal Access Token(PAT)写入代码或提交到 Git。核心思路是分离凭证与代码,通过环境变量注入 + 动态构建 Git URL 实现。
本文介绍一种安全、可复用的方案,让开发者在本地运行 pip install -r requirements.txt 时,也能自动拉取私有 github 仓库包,避免将 personal access token(pat)写入代码或提交到 git。核心思路是分离凭证与代码,通过环境变量注入 + 动态构建 git url 实现。
在 CI/CD 环境(如 GitHub Actions)中,我们通常借助 secrets.MACHINE_USER_PAT 安全注入 Token,并拼接为 git+https://${{ secrets.MACHINE_USER_PAT }}@github.com/... 完成私有包安装。但该方式无法直接复用于本地开发:既不能把 Token 明文写进 requirements.txt(违反安全原则),也不宜每次手动执行带 Token 的 pip 命令。
✅ 推荐实践:凭证外置 + 环境变量驱动安装脚本
-
安全存储 Token
在用户主目录下创建独立凭证文件(不在项目 Git 工作区中):echo "GITHUB_TOKEN=ghp_abc123xyz..." > ~/.github_token chmod 600 ~/.github_token # 严格限制读写权限
此文件不会被 Git 跟踪,且仅当前用户可读。
-
编写本地安装脚本(如
install-dev.sh)#!/bin/bash set -e # 遇错退出 # 加载凭证(仅本地生效) if [ -f "$HOME/.github_token" ]; then source "$HOME/.github_token" else echo "❌ Error: ~/.github_token not found. Please create it with GITHUB_TOKEN=..." >&2 exit 1 fi # 创建并激活虚拟环境 python -m venv .venv source .venv/bin/activate # 安装公共依赖 pip install -r requirements.txt # 动态安装私有包(支持多个) pip install "git+https://${GITHUB_TOKEN}@github.com/xxx-dna/dna-utils.git@main" # pip install "git+https://${GITHUB_TOKEN}@github.com/xxx-dna/another-private.git@v1.2.0" echo "✅ Development environment ready!" -
使用方式
chmod +x install-dev.sh ./install-dev.sh
⚠️ 关键注意事项
- 不要在
requirements.txt中直接写含 Token 的 URL(如git+https://token@...),否则极易误提交; - GitHub PAT 应具备
repo权限(读取私有仓库),并建议启用Expiration和最小化 scope; - 若团队协作,可在项目根目录提供
.github_token.example模板,并在README.md中说明配置流程; - 进阶可选:结合
python-decouple或dotenv在 Python 代码中统一管理敏感变量,但 pip 安装阶段仍需 shell 层注入。
该方案兼顾安全性、可维护性与开发者体验——CI 使用 secret 注入,本地复用同一逻辑链路,真正实现“一次配置,多端一致”。











