建自己的Python项目仓库,使用工具:GitHub(远程仓库)、GitHub Desktop(版本控制工具)、VSCode(代码编辑器)

发布于:2025-09-13 ⋅ 阅读:(12) ⋅ 点赞:(0)

结合 GitHub(远程仓库)、GitHub Desktop(版本控制工具)、VSCode(代码编辑器) 三个工具,以下是更具体的Python项目仓库搭建流程,包含工具协同操作的详细步骤:

一、整体流程概览

  1. GitHub:创建远程仓库(代码的“云端备份”)。
  2. GitHub Desktop:将远程仓库克隆到本地,管理代码提交、推送、分支等版本操作。
  3. VSCode:打开本地仓库,编写代码、管理依赖、运行测试,与前两者无缝联动。

二、详细步骤:从0到1搭建仓库

Step 1:在GitHub上创建远程仓库(云端初始化)
  1. 登录GitHub官网(https://github.com,有时需要科学上网),点击右上角“+”→“New repository”。
  2. 填写仓库信息:
    • Repository name:建议与项目名一致(如python-data-tools)。
    • Description:简要描述项目(如“一个处理CSV数据的Python工具库”)。
    • 勾选 “Add a README file”(自动生成基础说明文件)。
    • 勾选 “Add .gitignore”,并在下拉框选择 “Python”(自动生成Python专属的忽略规则)。
    • 选择许可证(如“MIT License”,开源项目必备)。
  3. 点击“Create repository”,远程仓库创建完成(如https://github.com/你的用户名/python-data-tools)。
Step 2:用GitHub Desktop克隆仓库到本地(关联本地与云端)
  1. 打开GitHub Desktop,点击左上角“File”→“Clone repository”。
  2. 在弹出的窗口中:
    • 切换到“GitHub.com”标签,找到刚创建的仓库(python-data-tools)。
    • 选择本地保存路径(如D:\projects\python-data-tools),点击“Clone”。
  3. 克隆完成后,GitHub Desktop会自动加载仓库,显示初始文件(README.md.gitignore等)。
Step 3:用VSCode打开本地仓库并搭建目录结构
  1. 在GitHub Desktop中,本地仓库名在左上角,右键仓库名称→点击“Open in Visual Studio Code”(直接用VSCode打开本地仓库)。
  2. 在VSCode的“资源管理器”(左侧目录列表,光标放入时出现右上角有增加目录和增加文件项)中,按以下结构创建目录和文件(仅示例):
python-data-tools/
├── src/                    # 源代码目录(大型项目推荐)
│   └── datatools/          # 核心包(自定义名称)
│       ├── __init__.py     # 包标识(内容可空)
│       ├── cleaner.py      # 数据清洗模块
│       └── analyzer.py     # 数据分析模块
├── tests/                  # 测试目录
│   ├── test_cleaner.py     # 测试cleaner.py
│   └── test_analyzer.py    # 测试analyzer.py
├── examples/               # 示例脚本
│   └── demo.py             # 演示如何使用核心功能
├── requirements.txt        # 依赖列表
└── README.md               # 项目说明(补充完善)
Step 4:用VSCode编写核心文件内容
(1)编写核心代码(以src/datatools/cleaner.py为例)

在VSCode中打开文件,输入功能代码:

def remove_duplicates(data: list) -> list:
    """移除列表中的重复元素并保持顺序"""
    seen = set()
    return [x for x in data if not (x in seen or seen.add(x))]

def trim_whitespace(text: str) -> str:
    """去除字符串首尾空格"""
    return text.strip()
(2)编写测试代码(tests/test_cleaner.py

安装测试工具(在VSCode终端中执行,终端可通过Ctrl+``打开):

pip install pytest  # 安装pytest测试框架

编写测试用例:

from src.datatools.cleaner import remove_duplicates, trim_whitespace

def test_remove_duplicates():
    assert remove_duplicates([1, 2, 2, 3]) == [1, 2, 3]
    assert remove_duplicates(["a", "a", "b"]) == ["a", "b"]

def test_trim_whitespace():
    assert trim_whitespace("  hello  ") == "hello"
    assert trim_whitespace("world") == "world"
(3)生成依赖文件(requirements.txt

在VSCode终端中导出当前环境依赖:

pip freeze > requirements.txt  # 将已安装的包(如pytest)写入文件

文件内容示例:

pytest==7.4.0
(4)完善README.md(在VSCode中编辑)

补充项目说明,包含安装、使用示例:

# Python Data Tools  
用于数据清洗和分析的轻量工具库。  

## 安装  

bash
pip install -r requirements.txt



## 快速使用  
python
from src.datatools.cleaner import remove_duplicates
print(remove_duplicates([1, 2, 2, 3]))  # 输出: [1, 2, 3]


## 运行测试  
```bash
pytest tests/  # 所有测试通过则无报错
Step 5:用GitHub Desktop提交并推送到GitHub
  1. 回到GitHub Desktop,左侧会自动检测到VSCode中修改/新增的文件(标绿为新增,标黄为修改)。
  2. 在下方“Summary”输入提交说明(如“初始化项目:添加数据清洗模块和测试”),点击“Commit to main”(提交到本地仓库)。
  3. 点击顶部“Push origin”,将本地提交推送到GitHub远程仓库(此时GitHub网页上的仓库会同步更新)。
    注:此时若网络不稳时,用科学上网
Step 6:日常开发流程(工具协同)
  • 修改代码:在VSCode中编辑文件(自动保存或Ctrl+S)。
  • 提交变更:GitHub Desktop会实时显示修改,填写说明后“Commit”。
  • 同步远程:点击“Push origin”推送本地修改;若他人更新了远程仓库,点击“Fetch origin”→“Pull origin”拉取最新代码(避免冲突)。
  • 分支管理:在GitHub Desktop中点击“Current branch”→“New branch”创建功能分支(如feature/add-plot),在VSCode中开发完成后,通过GitHub Desktop合并到main分支并推送。

三、工具协同技巧

  1. VSCode扩展增强体验

    • 安装 “Python” 扩展(微软官方):提供代码提示、测试运行、语法检查。
    • 安装 “Git History”:在VSCode中直接查看提交历史、文件修改记录。
    • 安装 “Todo Tree”:标记代码中的TODO,方便跟踪待完成任务。
  2. GitHub Desktop与VSCode联动

    • 在GitHub Desktop中右键文件→“Open in Visual Studio Code”:快速打开修改的文件。
    • 在VSCode的左下角可直接切换分支(与GitHub Desktop同步)。
  3. 依赖管理优化

    • 复杂项目推荐用pyproject.toml替代requirements.txt,在VSCode中安装pip-tools扩展,自动维护依赖版本。

四、仓库模板复用(快速上手)

  1. 在GitHub上搜索 “python-template”,找到带星标较多的仓库(如github.com/rochacbruno/python-package-template)。
  2. 进入该模板页面,点击右上角“Use this template”→“Create a new repository”,生成基于模板的新仓库。
  3. 用GitHub Desktop克隆到本地,用VSCode打开后直接修改内容(保留模板的目录结构和配置文件)。

通过以上流程,三个工具各司其职:GitHub负责远程托管,GitHub Desktop简化版本控制,VSCode专注代码开发,形成高效的协作闭环。即使是新手,也能通过可视化操作完成规范的Python项目管理。


网站公告

今日签到

点亮在社区的每一天
去签到