如何共享您的Python软件包

最新推荐文章于 2023-06-01 14:35:17 发布

cunjie3951

最新推荐文章于 2023-06-01 14:35:17 发布

阅读量866

点赞数

文章标签： java python 大数据 github pip

总览

Python包是Python应用程序的构建块。它们封装了一些连贯的功能，可以被许多应用程序和系统导入和使用。但是首先，开发人员需要找到您的软件包并能够安装它。 Python为软件包提供了免费的公共存储库，这是共享Python软件包的事实上的标准。您也可以将私有软件包存储库用于专有软件包。

在本教程中，您将学习如何与社区共享您自己的软件包。如果您拥有专有软件包，则只需要在公司内部共享，您还将学到如何做。

有关背景，请参见如何使用Python程序包和如何编写自己的Python程序包。

什么是PyPI？

PyPI代表Python包索引。它是用于上传软件包的公共存储库。 Pip知道PyPI，可以从PyPI安装和/或升级软件包。在Monty Python的著名素描之后，PyPI曾经被称为“奶酪店”。如果您听到人们在Python包装上下文中提到“奶酪店”，请不要惊慌。只是PyPI。

准备要上传的软件包

在上传软件包之前，您需要拥有一个软件包。我将使用在如何编写自己的Python包一文中介绍的conman包。由于PyPI包含成千上万个软件包，因此如果您希望人们找到它，能够正确描述您的软件包非常重要。 PyPI支持一组令人印象深刻的元数据标签，以使人们找到适合该工作的软件包。

setup.py文件包含许多用于安装软件包的重要信息。但它也可以包含用于在PyPI上对软件包进行分类的元数据。使用多个元数据标签对包进行分类。其中一些是文本的，其中一些具有可能值的列表。完整列表可在PyPI的“ 列表分类器”页面上找到。

让我们向setup.py添加一些分类器。无需增加版本号，因为它只是元数据，并且代码保持不变：

from setuptools import setup, find_packages



setup(name='conman',

      version='0.3',

      url='https://github.com/the-gigi/conman',

      license='MIT',

      author='Gigi Sayfan',

      author_email='the.gigi@gmail.com',

      description='Manage configuration files',

      classifiers=[

          'Development Status :: 3 - Alpha',

          'Intended Audience :: Developers',

          'Topic :: Software Development :: Libraries',

          'License :: OSI Approved :: MIT License',

          'Programming Language :: Python :: 2',

          'Programming Language :: Python :: 2.6',

          'Programming Language :: Python :: 2.7',

      ],

      packages=find_packages(exclude=['tests']),

      long_description=open('README.md').read(),

      zip_safe=False,

      setup_requires=['nose>=1.0'],

      test_suite='nose.collector')

创建一个帐户

您需要在PyPI上创建一个帐户才能上传包。填写此表单，然后单击验证电子邮件中的URL来验证您的身份。现在，您需要在主目录中创建一个.pypyrc文件，其中将包含上传软件包所需的信息。

[distutils]

index-servers=pypi



[pypi]

repository = https://pypi.python.org/pypi

username = the_gigi

您也可以添加密码，但是如果您不小心遇到一些不良情况，这会更安全。如果您上传受欢迎的软件包，这尤其重要，因为如果有人可以上传或升级您的软件包，则使用这些软件包的所有人员都将受到攻击。

测验

如果您想测试软件包注册和上传过程，而不必担心发布不完整的内容，则可以使用替代的PyPI测试站点。扩展〜/ .pypirc文件，使其包含“ pypitest”部分。

[distutils]

index-servers=

    pypi

    pypitest



[pypitest]

repository = https://testpypi.python.org/pypi

username = the_gigi



[pypi]

repository = https://pypi.python.org/pypi

username = the_gigi

请记住，测试站点要定期清理，所以不要依赖它。仅用于测试目的。

注册您的包裹

如果这是软件包的第一个版本，则需要在PyPI中注册。麻线有一个注册命令，但我不知道如何使用它。按照文档进行操作会产生错误，并且检查单元测试中是否存在麻线，没有针对register命令的测试。那好吧。您也可以使用此表格手动上传PKG-INFO文件。如果您使用的是Python 2.7.9+或Python 3.2+，则还可以使用python setup.py register安全地进行setup.py register 。

让我们在PyPI测试站点上注册conman。请注意-r pypitest ，它基于~/.pypirc的部分将在测试站点中注册。

python setup.py register -r pypitest

running register

running egg_info

writing conman.egg-info/PKG-INFO

writing top-level names to conman.egg-info/top_level.txt

writing dependency_links to conman.egg-info/dependency_links.txt

reading manifest file 'conman.egg-info/SOURCES.txt'

reading manifest template 'MANIFEST.in'

writing manifest file 'conman.egg-info/SOURCES.txt'

running check

Password:

Registering conman to https://testpypi.python.org/pypi

Server response (200): OK

缠绕

您可以使用python setup.py upload来上传软件包，但是它不安全，因为它以前一直通过HTTP发送用户名和密码，直到Python 2.7.9和Python 3.2。 Twine始终使用HTTPS，并具有其他优点，例如上传预先创建的发行版，并且支持任何包装格式，包括滚轮。我将使用麻线进行实际上传。

Twine不属于标准库，因此您需要安装它： pip install twine 。

上传您的包裹

最后，是时候实际上传软件包了。

> twine upload -r pypitest -p ******* dist/*

Uploading distributions to https://testpypi.python.org/pypi

Uploading conman-0.3-py2-none-any.whl

Uploading conman-0.3-py2.py3-none-any.whl

Uploading conman-0.3.tar.gz

Twine上传了所有发行格式，包括来源和版权。

Twine uploaded all the distribution formats

测试您的包裹

将软件包安装在PyPI上之后，您应该确保可以安装它并且一切正常。在这里，我创建一个一次性的虚拟环境，从PyPI测试站点pip install conman，然后将其导入。您可能需要对软件包运行更全面的测试。

> mkvirtualenv test_conman_pypi

New python executable in test_conman_pypi/bin/python2.7

Also creating executable in test_conman_pypi/bin/python

Installing setuptools, pip...done.

Usage: source deactivate



removes the 'bin' directory of the environment activated with 'source

activate' from PATH.

(test_conman_pypi) > pip install -i https://testpypi.python.org/pypi conman

Downloading/unpacking conman

  Downloading conman-0.3-py2-none-any.whl

  Storing download in cache at /Users/gigi/.cache/pip/https%3A%2F%2Ftestpypi.python.org%2Fpackages%2Fpy2%2Fc%2Fconman%2Fconman-0.3-py2-none-any.whl

Installing collected packages: conman

Successfully installed conman

Cleaning up...

(test_conman_pypi) > python

Python 2.7.10 (default, Jun 10 2015, 19:43:32)

[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)] on darwin

Type "help", "copyright", "credits" or "license" for more information.

>>> import conman

>>>

请注意，轮分布默认情况下已安装。

版本控制

当您升级软件包并上传新版本时，请遵循明智的版本控制方案，这一点很重要。如果无意的升级破坏了他们的代码，人们会很不高兴。您的版本控制方案必须符合PEP-440 –版本标识和依赖项规范。

该规范允许选择多种方案。我建议使用流行的语义版本控制方案。它几乎是“ <major>。<minor>。<patch>”，与PEP-440的“ <major>。<minor>。<micro>”相对应。请当心那些带有连字符或加号的版本，这些版本与PEP-440不兼容。

私人包装仓库

PyPI很棒，但有时您不想共享您的软件包。许多公司和组织的工程团队使用Python，并且需要在它们之间共享软件包，但不允许在PyPI上公开共享它们。这不是问题。您可以在您的控制下在私有软件包存储库上共享软件包。

请注意，有时您可能希望拥有一个私有软件包存储库以控制您的第三方依赖项。例如，包作者可以决定从PyPI删除包。如果您的系统依赖于能够从PyPI安装此软件包，则您会遇到麻烦。

德皮

Devpi （代表开发包索引）是公共PyPI服务器的直接替代品。它是开源的，并获得了MIT的许可，因此您可以在防火墙内运行它。 Devpi非常强大，并具有许多功能使其可以用作最终的打包服务器：

快速PyPI镜
使用私有索引上载，测试和暂存
索引继承
Web界面和搜索
复写
导入/导出
詹金斯整合

Devpi拥有出色的文档和插件系统，并且正在与活跃的社区进行积极的开发。

结论

Python提供了一个完整的解决方案，用于托管您的软件包并将其提供给其他Pythonista使用者。有一个简化的过程，借助工具来打包和上传软件包，并使它们易于查找和安装。

如果您需要将事情保密，Devpi将在这里为您提供成熟而强大的私有软件包存储库。

翻译自: https://code.tutsplus.com/tutorials/how-to-share-your-python-packages--cms-26114

cunjie3951

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
如何共享您的Python软件包

总览 Python包是Python应用程序的构建块。它们封装了一些连贯的功能，可以被许多应用程序和系统导入和使用。但是首先，开发人员需要找到您的软件包并能够安装它。 Python为软件包提供了免费的公共存储库，这是共享Python软件包的事实上的标准。您也可以将私有软件包存储库用于专有软件包。在本教程中，您将学习如何与社区共享您自己的软件包。如果您拥有专有软件包，则只需要在公...
复制链接

扫一扫