如何在本地环境中从GitHub Desktop克隆的仓库开发运行Python包

1. Fork并克隆仓库 #

• 打开GitHub网页，找到目标Python包仓库，点击右上角「Fork」按钮，将仓库复制到自己的GitHub账号下。
• 打开GitHub Desktop，点击「File」→「Clone repository」，选择刚fork的仓库，选择本地非site-packages的目录（比如~/projects/your-package）完成克隆。

2. 创建并激活conda开发环境 #

• 打开终端（或Anaconda Prompt），进入克隆好的仓库目录：

  cd ~/projects/your-package
  

• 根据仓库依赖文件创建conda环境：
  • 若存在environment.yml：

    conda env create -f environment.yml
    

  • 若只有requirements.txt：

    conda create -n your-dev-env python=3.x
    conda activate your-dev-env
    pip install -r requirements.txt
    

• 激活环境：

  conda activate your-dev-env
  

3. 以开发模式安装本地包 #

这是解决冲突的核心操作：

• 在激活的conda环境中，进入仓库根目录，执行：

  pip install -e .
  

  该命令会在site-packages中创建符号链接（Windows下为快捷方式），指向本地仓库的包源码目录。既让conda环境能识别包，又保留仓库原有的README、setup.py等文件结构，完全避免冲突。

4. 开发与测试 #

• 直接在本地克隆的仓库目录中修改代码，开发模式下修改后的代码会立即被conda环境识别，无需重新安装。
• 运行测试或使用包功能时，确保conda环境处于激活状态即可。

5. 提交更新到在线仓库 #

• 用GitHub Desktop打开本地仓库，查看修改文件，填写提交信息后点击「Commit to main」（或对应分支）。
• 点击「Push origin」，将提交推送到你fork的远程仓库。
• 若需向原仓库贡献代码，可在GitHub网页发起Pull Request。

关键说明 #

• 无需将整个仓库放入site-packages：仓库根目录的非源码文件（README、配置文件等）不属于包的核心内容，强行放入会导致结构混乱，开发模式的符号链接方式更合理。
• 卸载开发模式包：激活conda环境后执行pip uninstall your-package-name，符号链接会被移除，本地仓库文件不受影响。

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