第一步:在 GitHub 上创建新的远程仓库
- 打开你的 GitHub 网站,创建新的仓库,填写仓库名称、描述等信息。
- 创建时不要勾选
Add a README file;开源协议随便选一个就行。
- 创建好的仓库页面,其中包含了远程仓库的 URL。复制这个 URL,我们稍后会用到。
第二步:在本地项目中初始化 Git
- 打开 VS Code,导航到你的本地项目文件夹
- 创建并编辑
.gitignore 文件,一个常见的 Python 项目 .gitignore 示例如下
1
2
3
4
5
|
venv/
__pycache__/
*.pyc
*.log
*.DS_Store
|
- 运行
git init 初始化本地 Git 仓库,这会在你的项目目录下创建一个 .git 文件夹。本地仓库初始化后,默认的初始分支名称通常是 master。
第三步:链接本地仓库和远程仓库
- 在 VS Code 的终端中,运行以下命令,将你的 GitHub 仓库 URL 添加为远程仓库
origin(即上面复制的仓库URL)
1
|
git remote add origin https://github.com/peter-zx/IDfenxi.git
|
第四步:修改本地仓库名称 (如果需要)
- GitHub 新创建的仓库默认分支名称通常是
main,而本地 git init 后的默认分支可能是 master(如上图所示)。为了保持一致,推荐修改本地分支名称。
- 在 VS Code 的终端中运行,这会将你的本地
master 分支重命名为 main。如果你本地仓库已经是 main,则跳过此步骤
第五步:拉取远程仓库内容到本地(可选)
- 由于远程仓库可能包含 README、LICENSE 等文件,我们需要先将其拉取到本地,以避免推送时的冲突。
- 打开 VS Code 的终端,运行以下命令来拉取远程
origin 的 main 分支内容到你的本地 main 分支
这个命令会将远程 origin/main 分支的更改合并到你当前的本地 main 分支。如果这是第一次拉取,它会下载远程仓库的文件。
第六步:暂存和提交你的本地代码
1
2
3
4
5
6
7
8
9
10
|
git init
git add .
git commit -m "xxx"
git pull origin main #一般在这个时候执行(如果本地和github远程cang'ku)
# 第一次推送
git push -u origin main
# 后续推送
git push
|
第七步:补充文件
- 补充项目的
requirement.text文件。
- 使用第三方库
pipreqs生成项目的 requirements.txt 文件,pipreqs会分析项目中的 Python 源代码文件,找出所有依赖的包,并将它们及其版本写入 requirements.txt 文件。pipreqs可以只将用到的库生成到requirements.txt文件。
1
2
3
4
5
6
7
8
|
# 先安装pipreqs库
pip install pipreqs
# 生成requirements.txt,在当前项目根目录使用pipreqs命令
pipreqs ./ --encoding=utf8 --force
# 一键安装项目需要的库
pip install -r requirements.txt
|
参考链接
使用VSCode推送本地项目到GitHub
生成requirements.txt文件