如何将你的 python 包上传到 PyPi

墨蓝 2022-09-03 06:26 147阅读 0赞

![在这里插入图片描述][8ac1d81d0e814fedb48dac680e3e058d.jpg]

PyPi 包索引是使 Python 如此强大的特性之一：只需一个简单的命令，您就可以访问数以千计的酷库，随时可供您使用。在这个简短的介绍中，我将解释如何将自己的代码上传到 PyPi 并让其他人从您的发明中获利。在接下来的页面中，我将向您展示以下步骤：  
使您的代码准备好发布  
创建一个 python 包  
创建 PyPi 需要的文件  
创建一个 PyPi 帐户  
将您的包  
上传到 github.com  
将您的包上传到 PyPi安装您自己的包使用 pip  
更改您的包  
![在这里插入图片描述][2541214b025d41f9805ba495723478f5.gif]

关于如何将包上传到 PyPi 并通过 pip 安装的完整指南。截图：PyPi.org  
但什么是 PyPi？  
好吧，根据他们的网站：  
Python Package Index (PyPI) 是 Python 编程语言的软件存储库。PyPI 可帮助您查找和安装由 Python 社区开发和共享的软件。了解安装软件包。包作者使用 PyPI 来分发他们的软件。了解如何为 PyPI 打包 Python 代码。  
如何使用 PyPi  
我相信你们中的大多数人已经安装了 PyPi (pip) 并使用了它。如果你没有，你绝对应该！就像下载这个文件一样简单。现在，打开您的命令提示符并通过“cd”导航到下载文件所在的目录。然后，运行命令“python get-pip.py”。  
cd “C://PATH//TO//YOUR//DOWNLOADED//FILE”  
python get-pip.py  
要使用 pip，请在控制台中输入“pip insall packagename”。当你想安装scrapy时，你输入以下命令：  
pip install scrapeasy  
您是否收到错误消息，指出“pip”不是内部或外部命令、可运行的程序或批处理文件。？不要惊慌，我们得到了这个。您的 pip 脚本不在 windows 环境变量中，因此您无法从系统上的任何地方访问它。让我们使用以下命令修复此问题：  
setx PATH “%PATH%;C://WHERE//PYTHON//IS//INSTALLED//Scripts”  
或者，作为示例  
setx PATH "%PATH%;C:\\Python36\\脚本”  
它现在应该可以工作了。  
使您的代码准备好发布  
让我们为上传准备您的代码。首先，您应该从代码中删除所有“打印”语句。当您使用库并且您的命令提示符充斥着不属于您的打印消息时，这很烦人 - 因此将它们全部删除。如果您想通知用户某些活动，请使用日志记录。  
还要确保不包含存在于函数类之外的代码，否则每次有人导入您的库时都会运行此代码。如果您想在类中包含示例代码（这是合法的），请将其包装到“ main ”函数中。

创建一个python包  
要创建一个包，请创建一个文件夹，该文件夹的名称与您希望包的命名方式完全相同。将您要发送的所有文件和类放入此文件夹中。  
现在，创建一个名为init .py的文件（同样是两个下划线）。使用您选择的文本编辑器打开文件。在此文件中，您只编写具有以下架构的 import 语句：

在初始化.py文件是用来给你希望用户通过封装接口访问哪些类标志。让我们举个例子。假设您想将名为“MyLib”的库上传到 PyPi。首先，创建一个名为“MyLib”的文件夹并将您的类放在其中。  
MyLib  
\-Class1.py  
\-Class2.py  
然后，删除所有打印语句和所有不在类中的代码。  
最后，创建init.py文件并导入用户应该访问的所有方法。  
MyLib

*  init .py  
    \-File1.py  
    \-File1.py  
    ![在这里插入图片描述][b0f72bba1cf248afba4abae3f1e6b9c6.jpg]

创建 PyPi 帐户  
您可以在此处注册 PyPi 帐户。记住您的用户名（不是姓名，不是电子邮件地址）和密码，稍后上传过程中将需要它。  
将您的包上传到 github.com  
创建一个 github 存储库，其中包含我们将要创建的所有文件以及您的包文件夹。完全按照包命名 repo。您可以在此处找到此类回购的示例。  
创建 PyPi 需要的文件 PyPi 需要  
三个文件才能工作：  
setup.py  
setup.cfg  
LICENSE.txt  
README.md（可选但强烈推荐）  
将所有这些文件放在包文件夹之外：  
MyLib  
setup.py  
setup.cfg  
LICENSE 。文本  
README.md  
让我们一一浏览这些文件  
setup.py  
setup.py 文件包含有关 PyPi 需要的包的信息，例如其名称、描述、当前版本等。复制并粘贴以下代码并替换具有匹配内容的字符串：

让我进一步解释 download\_url 和 install\_requires。  
download\_url  
您之前已将您的项目上传到您的 github 存储库。现在，我们在 github 上为您的项目创建一个新的发布版本。然后，任何运行“pip install YourPackage”命令的人都会下载此版本。  
首先，转到 github.com 并导航到您的存储库。接下来，单击选项卡“发布”，然后单击“创建新版本”。现在，定义一个标签版本（最好使用与您在 setup.py 版本字段中使用的编号相同的编号：v\_01。添加发布标题和描述（不那么重要），然后单击“发布发布”。现在您看到一个新版本，在 Assets 下，有一个指向 Source Code (tar.gz) 的链接。右键单击此链接并选择 Copy Link Address。将此链接地址粘贴到 setup.py 文件中的 download\_url 字段中. 以后每次你想更新你的包时，上传一个新版本到 github，创建一个我们刚刚讨论的新版本，指定一个新的版本标签，并将 Source 的链接复制粘贴到 setup.py 文件中（不要忘记也增加版本号）  
。Install\_requires  
在这里，您定义您的包所具有的所有依赖项——您要导入的所有 pip 包。简单地说：浏览您所有的课程并观看您导入的内容。您通过 pip 导入和下载的每个包（最有可能是所有包，除了标准库）必须通过添加包名称在此处作为 install\_requires 列出。  
让我给你举个例子

包“numpy”和“scrapeasy”是通过pip下载的，所以你需要在你的依赖项中添加“numpy”和“scrapeasy”。但是你怎么知道一个包是标准库还是通过pip下载的呢？好吧，只需打开您的 cmd 并键入 pip install packagename。如果你得到“要求已经满足”，你就可以开始了。如果您收到一条错误消息，指出“找不到满足要求的版本”，您就知道该软件包不是通过 pip 安装的，也不是通过标准库安装的。  
生成的 install\_requires 字段如下所示：

setup.cfg  
这是一个简短的。创建一个名为“setup.cfg”的新文件。如果你有一个描述文件（你绝对应该！），你可以在这里指定它：

LICENSE.txt  
使用此文件定义所有许可证详细信息。最有可能的是，只需将本网站的许可证文本复制粘贴到 LICENSE.txt 文件中即可。我总是在我的项目中使用 MIT 许可证，但也可以随意使用您自己的许可证。

README.md（可选）  
使用这个漂亮的网站创建一个 markdown 文件，然后下载它并将其放入您的目录中。  
将您的包上传到 PyPi  
现在，最后一步已经到来：将您的项目上传到 PyPi。首先，打开命令提示符并导航到所有文件和包所在的文件夹：  
cd “C://PATH//TO//YOUR//FOLDER”  
现在，我们使用以下内容创建源分发命令：  
python setup.py sdist  
您可能会收到一条警告，指出“未知分发选项：‘install\_requires’。只是忽略它。  
我们需要在上传过程中使用 twine，所以首先通过  
pip 安装 twine ：pip install twine  
然后，运行以下命令：  
twine upload dist/\*  
您将被要求提供您的用户名和密码。提供您之前用于注册 PyPi 的凭据。  
恭喜，您的包现已上传！访问https://pypi.org/project/YOURPACKAGENAME/在线查看您的包！  
使用 pip 安装你自己的包  
好的，现在让我们测试一下。打开您的控制台并输入以下命令：  
pip install YOURPACKAGENAME  
它有效！现在打开 python SHELL/IDLE 并导入你的包。  
改变你的包裹  
如果您维护好您的包，您将需要不时更改源代码形式。这很简单。只需将您的新代码上传到 github，创建一个新版本，然后调整 setup.py 文件（新的 download\_url — 根据您的新发布标签、新版本），然后再次运行 setup.py 和 twin 命令（导航到您的文件夹第一！）  
python setup.py sdist  
twine upload dist/\*  
最后，通过 pip 更新你的包，看看你的更改是否有效：  
pip install YOURPACKAGE --upgrade  
如果你需要软件开发或人工智能方面的专家，请查看我的软件苏黎世的开发公司

[8ac1d81d0e814fedb48dac680e3e058d.jpg]: /images/20220829/2fd69f739e944944b9eba05aca9e32ae.png
[2541214b025d41f9805ba495723478f5.gif]: /images/20220829/719fd7b1618449a48eebc1f7022c845f.png
[b0f72bba1cf248afba4abae3f1e6b9c6.jpg]: /images/20220829/6b8ae18de8404a1088cdec46fad1d7c1.png