创建python包的最佳编码实践是什么

时间:2020-06-29 03:26:39

标签: python-3.x pip package pypi

我正在创建pypi python软件包,为此,我厌倦了许多可在不同网站上使用的解决方案。

  1. 首先,我遵循了这个Approach1,在这种方法中,作者创建了classfunctions,但是当我尝试了这个过程时,我的包裹给了我一个错误,no moduleclass name is not define
  2. 在这种方法中,我厌倦了许多其他方法,例如Approach2,作者仅创建了functions,而没有class__init__.py
  3. 然后尝试了一种非常常见的Approach3

这是pypi官员提供的重要文件结构

├── LICENSE
├── README.md
├── example_pkg
│   └── __init__.py
├── setup.py
└── tests

我已经准备好打包,但是整夜都在寻找哪种是最佳编码实践?现在很困惑

所以我的问题如下

  1. __init__.py文件有什么用途?
  2. 给出目录,类和函数名称以便在导入期间有所帮助的最佳实践。因为根据这些answers,有人说导入目录名,有人说文件名后跟类,等等。
  3. 任何人都可以向我提供适当的步骤,以便我也可以遵循即将到来的软件包

1 个答案:

答案 0 :(得分:1)

我建议遵循https://packaging.python.org上的Python打包机构指南和教程。

此外,PyPA还发布了一个示例项目框架,您可以将其用作起点:https://github.com/pypa/sampleproject/

相关问题