macOS&&Pycharm-Pycham集成GitGitHub及其应用

Posted 2021-03-19 ittimeline

macOS&&Pycharm-Pycham集成GitGitHub及其应用

macOS&&Pycharm

git基本应用

git介绍

git是继SVN之后的版本管理系统,由Linux内核开发者Linus Benedict Torvalds大神开发。
和SVN集中式管理不同的是，Git是分布式版本管理系统，每个本地客户端都有一个完整的版本管理，减少远程Git服务器版本的依赖。目前在企业中使用的Git主要是GitHub和GitLab，它们两者的区别是GitHub主要用于开源项目，而Gitlab主要使用公司内部项目(非开源)。
国内的Gitee也可以用于托管开源项目。

macOS安装git

无论你是想使用Gitlab或者是GitHub，首先得在本地安装git客户端。

首先我们可以去git官网下载最新版本的客户端，目前最新版本是2.24.1。

由于git客户端是托管在sourceforge站点，在国内下载的速度可能会比较慢。

可以将下载链接复制到迅雷中下载。

下载完成后双击git-2.23.0-intel-universal-mavericks.dmg文件

git-2.23.0-intel-universal-mavericks.dmg

然后在双击git-2.23.0-intel-universal-mavericks.pkg文件开始安装git

介绍

安装类型

安装和配置安装

安装成功

git配置

在使用git之前还需要配置用户名和邮箱，那样在提交代码时可以看到提交人的名字和邮箱。使用git config 命令配置即可。

liuguangleideMacBook-Pro:~ liuguanglei$ git config --global user.name "liuguanglei"
liuguangleideMacBook-Pro:~ liuguanglei$ git config --global user.email "[e-mail]"

配置用户名和邮箱

使用Pycharm 开发Python程序

Pycharm配置文件模板

在编写Java程序之前，需要配置Python文件模板

启动Pycharm后，首先选择右下角的Configure->Preferences

然后搜索File and Code Templates

配置Python文件的模板

"""
@author liuguanglei [e-mail]
@wechat 18601767221
@website ittimeline.net
@version ${DATE} ${TIME}
@since python3.8
"""

使用Pycharm创建项目

前提条件是必须安装Python3.8解释器

启动Pycharm,选择Create new project

设置项目路径和Python解释器路径

首次创建项目或者启动Pycharm时Pycharm会弹出一个欢迎的窗口，如果不想看到这个窗口，可以去掉Show tips on startup的单选框。

python-core项目结构概览

Python版hello world实现

首先选中python-core,然后New->Python Package，

依次创建net/ittimeline/python/core/foundational/object

然后在net/ittimeline/python/core/foundational/object包下创建名为helloworld.py的Python源文件

当文件创建成功后，会看到之前配置的Python文件模板的内容包含在该文件中

然后编写

print("macOS10.15.2 && Python3.8&&Pycharm2019.3.1 Hello World With Python")

运行helloworld

程序运行结果

Pycharm ignore插件应用

在将python-core上传至github前，首先需要处理一些不需要上传的文件，例如Pycharm的.idea目录。

这里可以在Pycharm中安装.gitignore插件来统一管理这些不需要的文件,依然使用快捷键Command+,进入Preferences，然后在搜索栏中搜plugins，找到右边的Marketplace，即插件市场，然后在Marketplace的搜索栏中搜索.gitignore，点击安装，然后重启Pycharm。

点击Accept

重启Pycharm

.gitignore插件安装完成后，选中python-core，创建.gitignore file(git)

然后选择python的.ignore文件

如果以后有其他的不想提交的文件或者目录，选则文件或目录右键添加到.ignore文件即可,例如Pycharm的.idea目录，或者是直接在.ignore文件中添加.idea。

完整的.ignore文件

# Created by .ignore support plugin (hsz.mobi)
### Python template
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
#  Usually these files are written by a python script from a template
#  before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
#   However, in case of collaboration, if having platform-specific dependencies or dependencies
#   having no cross-platform support, pipenv may install dependencies that don‘t work, or not
#   install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

.idea

如果在Pycharm中不想查看被忽略的文件，可以选中python-core,然后Hide .ignore files

Pycharm集成GitHub

首先在Pycharm中使用快捷键Command+,进入Preferences，然后搜索Gitub

然后输入账号和密码登录GitHub

登录成功

Pycharm上传python-core至github

前提条件是本地安装了git客户端
并且之前已经注册号了GitHub账号
而且Pycharm中已经登录了GitHub账号

在将项目python-core提交到GitHub之前，首先需要在根目录创建一个README.md文件.
README.md文件用于描述项目，几乎所有流行的开源项目都会有这个文件。
本次提交只会在README.md文件中描述涉及到的开发环境说明。


然后找到该文件在磁盘的目录

使用markdown编辑器typora编辑内容

README.md

在Pycharm中上传python-core至github前，需要确保Github远程仓库中不存在该仓库，然后
点击菜单栏VCS->Import into version control->Share Project on GitHub

此时Pycharm会连接GitHub,GitHub服务端会验证账号信息

，账号通过之后。填写项目说明，

然后点击Share

然后选择首次提交的文件列表以及提交说明
由于有了.ignore文件,.idea文件提交时被忽略了。

首次提交文件列表

此时Pycharm会借助本地的Git客户端将python-core推送到远程的GitHub，默认分支是master,如果推送成功，右下角会看到提示信息。

push success

同时也可以通过浏览器访问GitHub，登录账号查看之前推送的python-core项目

Pycharm git应用

在Pycharm中使用Git特别的方便，Pycharm提供了Git菜单列表

和Git视图来完成Git的日常常用操作

如果你熟悉git命令的使用，那么这里的菜单对你来说是如虎添翼。

当新建hellodate.py文件时，git会提示是否自动添加到Git的流程管理下
这里勾选Remeber,don‘t ask agin。

"""
@author liuguanlgei [e-mail]
@wechat 18601767221
@website ittimeline.net
@version 2019/12/25 8:18 下午
@since python3.8
"""
import time

# 获取当前时间
print(time.strftime("%Y-%m-%d %H:%M:%S", time.localtime()))

如果想要将hellodate.py提交到GitHub，可以使用快捷键Command+k提交，提交代码前编写本次本次修改的内容。

然后点击右下角的Commit and Push 即可推送到远程的GitHub。
在推送GitHub之前还需要选择推送的分支，因为python-core只有一个分支，因此推送至master即可。

在Pycharm提供的git视图中可以查看到提交记录

Pycharm提交记录

还可以从GitHub中查看提交记录

Python企业项目开发中开发通常都会针对不同的环境(开发环境、测试环境、线上环境)建立不同的分支，同时项目的开发通常是多个开发人员同时进行的，因此还会涉及到团队协同的操作，等到系统学习Git时再细聊吧。