PyCharm 项目上传至 GitHub 详细操作说明
一、前提准备
- 注册 GitHub 账号,访问 https://github.com 并完成注册。
- 安装 Git:确保本机安装了 Git。可以从 https://git-scm.com/download 下载并安装。
- 配置 Git 用户信息(首次使用):
git config --global user.name “你的GitHub用户名”
git config --global user.email “你的邮箱”
二、在 GitHub 上创建远程仓库
- 登录 GitHub。
- 点击右上角“+”号,选择“新建仓库”。
- 填写仓库名称,选择公开或私有,不要勾选初始化 README,点击创建。
- 复制仓库的 HTTPS 地址,形如:https://github.com/你的用户名/仓库名.git
三、在 GitHub 生成个人访问令牌(Personal Access Token,PAT)
- 登录 GitHub,进入 设置(Settings)。
- 选择左侧菜单的 开发者设置(Developer settings)。
- 点击 个人访问令牌(Personal access tokens) > 令牌(经典)(Tokens (classic))。
- 点击 生成新令牌(经典)(Generate new token (classic))。
- 填写名称,如“PyCharm”,设置过期时间。
- 勾选权限 repo(仓库权限)。
- 生成令牌后,复制并妥善保存(关闭页面后无法再次查看)。
四、PyCharm 中配置 Git 和 GitHub 账号
- 打开 PyCharm,进入菜单:文件 > 设置 > 版本控制 > Git,确认 Git 可执行文件路径正确,点击测试。
- 进入 版本控制 > GitHub,点击“添加账户”,选择使用令牌登录。
- 粘贴刚才生成的个人访问令牌,确认绑定成功。
五、初始化本地 Git 仓库(启用版本控制)
- 在 PyCharm 项目根目录,右键点击,菜单中选择:版本控制(或 Git) > 启用版本控制集成。
- 选择 Git,点击确定。
- 如果没有此选项,可通过顶部菜单:VCS > 启用版本控制集成,选择 Git。
或者在 PyCharm 终端手动执行:git init
六、创建并配置 .gitignore 文件(忽略无关文件)
建议在项目根目录创建 .gitignore 文件,内容如下(适合 Python 项目):
Python 通用忽略规则
pycache/
*.py[cod]
*$py.class
*.so
*.egg-info/
dist/
build/
.eggs/
venv/
ENV/
env/
.venv/
.idea/
.vscode/
.ipynb_checkpoints/
*.log
.env
.env.
*.whl
*.tar.gz
.DS_Store
Thumbs.db
desktop.ini
.cache/
pip-wheel-metadata/
.mypy_cache/
.pyre/
.pytype/
.coverage
htmlcov/
*.manifest
*.spec
七、将文件添加至 Git 并提交
- 在 PyCharm 终端执行:git add .
- 查看状态,确认文件已被追踪:git status
- 提交代码:git commit -m “首次提交项目代码”
八、关联远程仓库并推送代码
- 关联远程仓库(用你自己的仓库地址替换下面地址):
git remote add origin https://github.com/你的用户名/仓库名.git - 查看本地分支名称:git branch
- 推送代码到远程仓库:git push -u origin main(如果分支是 master,改为 git push -u origin master)
九、PyCharm 图形界面操作提交(可选)
- 进入 版本控制 > 提交(快捷键 Ctrl+K / Cmd+K)。
- 选择要提交的文件,填写提交信息。
- 点击 提交 或 提交并推送,上传代码。
十、关于 Git 换行符警告说明
执行 git add . 时可能会出现如下警告:
warning: in the working copy of ‘filename’, LF will be replaced by CRLF the next time Git touches it
含义:LF 是 Linux/macOS 的换行符,CRLF 是 Windows 的换行符,该警告提示 Git 将自动把 LF 转为 Windows 的 CRLF。
处理建议:一般无影响,可以忽略,直接提交。
若想消除警告,执行:git config --global core.autocrlf true
此设置可自动处理换行符转换,保证跨平台兼容。
十一、总结
- 请确保 Git 安装正确并配置用户名邮箱。
- 在 GitHub 创建仓库并复制远程地址。
- 在 GitHub 生成个人访问令牌,绑定到 PyCharm。
- 在 PyCharm 启用 Git 版本控制,创建 .gitignore 文件。
- 通过命令行或 PyCharm 提交并推送代码到 GitHub。
- 不用担心换行符警告,设置好 core.autocrlf 即可。