Visual Studio Code中GitHub共享项目导入配置：实现克隆后直接运行无需装依赖

首先明确禁止的操作 #

不要将本地的virtual environment文件夹上传到GitHub仓库，原因如下：

• 虚拟环境内的文件和你的本地操作系统、Python版本、CPU架构强绑定，其他用户下载后完全无法直接使用，反而会出现兼容性报错
• 虚拟环境体积通常可达几百MB，会严重占用仓库存储空间，拖慢克隆、拉取的速度
• 后续依赖更新时你也无法同步维护虚拟环境内的文件，会导致依赖版本不一致的问题
  建议把你的虚拟环境目录名称添加到项目根目录的.gitignore文件中，避免误提交。

方案1：行业通用标准方案（维护成本最低） #

这是目前所有Python开源项目的通用规范，操作简单，开发者接受度高：

1. 在你本地激活虚拟环境的状态下，执行命令pip freeze > requirements.txt，将当前项目所有依赖的版本信息导出到项目根目录的requirements.txt文件
2. 将requirements.txt上传到GitHub仓库
3. 用户克隆仓库后仅需执行3条命令即可运行项目：
   • 创建虚拟环境：python -m venv venv
   • 激活虚拟环境：Windows执行venv\Scripts\activate，Mac/Linux执行source venv/bin/activate
   • 安装依赖：pip install -r requirements.txt

方案2：一键启动方案（用户无需手动执行环境命令） #

如果想要进一步降低用户的操作成本，可以编写对应系统的启动脚本，把所有环境配置逻辑集成到脚本中：

• 针对Windows用户，在项目根目录新建run.bat文件，写入以下内容（最后一行替换为你实际的项目启动命令）：

  @echo off
  if not exist venv (
      python -m venv venv
  )
  call venv\Scripts\activate
  pip install -r requirements.txt
  python main.py
  pause
  

• 针对Mac/Linux用户，在项目根目录新建run.sh文件，写入以下内容（最后一行替换为你实际的项目启动命令）：

  #!/bin/bash
  if [ ! -d "venv" ]; then
      python3 -m venv venv
  fi
  source venv/bin/activate
  pip install -r requirements.txt
  python3 main.py
  

• 将两个脚本文件和requirements.txt一起上传到仓库，用户克隆后：Windows用户直接双击run.bat即可自动完成环境配置和项目启动，Mac/Linux用户仅需执行bash run.sh即可运行。

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