开源自定义Python库并上传到PyPi
0. 准备工作
推荐环境需求:
Ubuntu20.04及以上
python3.8以上
0.1 安装git
sudo apt update
sudo apt-get install git
0.2 安装Python相关库
pip install twine wheel
0.3 注册一个GitHub账户
注册地址: https://github.com/
0.4 注册一个PyPi账户
注册地址: https://pypi.org/account/register/
0.5 安装令牌管理应用
这里推荐一个GitHub开源项目:https://github.com/beemdevelopment/Aegis
1. 创建GitHub仓库
2.1 新建仓库
登录上自己的GitHub账户,在主页点击创建仓库的图标
2.2 填写仓库信息
按照下图填写即可
2.3 设置SSH key
打开一个虚拟终端运行:
$ ssh-keygen -t rsa -C "<你的GitHub账户>"
查看Key
$ ls ~/.ssh
id_rsa id_rsa.pub known_hosts
id_rsa
、id_rsa.pub
就是 SSH Key 的秘钥对,id_rsa
是私钥,不能泄露出去,id_rsa.pub
是公钥。
$ cat ~/.ssh/id_rsa.pub
2.4 上传公钥到GitHub
登录到GitHub之后,点击自己的头像,然后点击列表中的Settings
然后点击SSH and GPG keys
在弹出的新界面中点击 New SSH key
填写信息,将cat ~/.ssh/id_rsa.pub
命令查询到的内容复制到下面的key
一栏
**注意:**点击Add SSH key
后会跳转到验证GitHub账户的界面,输入自己的密码登录即可
在下面即可看到刚才添加的公钥
2. 本地项目上传至GitHub仓库
首先打开一个虚拟终端,输入以下命令,测试GitHub连通性
$ ssh -T git@github.com
Hi LeurDeLis! You've successfully authenticated, but GitHub does not provide shell access.
设置GitHub用户名和邮箱,用户名为注册时填写的名字, 邮箱为注册GitHub时的账户
$ git config --global user.email xxx@xxx.com
$ git config --global user.name “xxxxx”
查看是否添加成功
$ git config -l
user.email=xxx@xxx.com
user.name=“xxxxx”
1.1 创建项目目录
创建目录结构如下,例如我的项目名为BusServoControl,__init__.py
文件要和源码放在同一级目录下
BusServoControl/
├── LICENSE
├── README.md
├── setup.py
└── BusServoControl/├── __init__.py└── BusServoControl.py
注意: 项目名要和GitHub上面创建的仓库名保持一致
1.2 git初始化
使用 git init
命令,可以将一个普通的目录转变为一个可以使用 Git 进行版本控制的代码库。在代码库中,Git 将跟踪和管理代码的历史记录、分支和更改。
$ git init