我正在尝试使我的git存储库可点安装。为此,我正在重组仓库以遵循正确的约定。通过查看其他存储库,我的理解是,我应该将所有源代码放在与存储库名称同名的程序包中。例如。如果我的存储库称为myrepo
,则源代码将全部放入一个也称为myrepo
的程序包中。
我的存储库中带有连字符以提高可读性:例如my-repo
。因此,如果我想为其包装一个相同的名称,则其中也将带有连字符。 In this tutorial对于python软件包名称说“不要使用连字符”。但是,我看到了完善的软件包,例如scikit-learn
,其名称中带有连字符。我注意到的一件事是,在scikit-learn
存储库中,程序包名称与存储库名称不同,而是被称为sklearn
。
我认为以上讨论归结为以下问题:
scikit-learn
的程序包名称是sklearn
,那么安装它后我怎么做pip install scikit-learn
而不是pip install sklearn
?答案 0 :(得分:4)
为回答您的第一点,让我改my answer为另一个问题。
造成误解的最大原因是“包裹”一词的重载。游戏中有4种不同的名称-存储库名称,用于开发的目录名称(包含setup.py
的目录名称,包含__init__.py
的目录名称以及其他可导入名称模块,在PyPI上的分发名称。通常这4个都是相同或相似的,但这不是必需的。
存储库和开发目录的名称可以是任何名称,它们的名称不起作用。当然,正确命名它们很方便,但这只是方便。
带有Python文件的目录名称为要导入的包命名。将包命名为要导入后,该名称通常会停留并且无法更改。
分发的名称在PyPI上显示一页,并且分发文件的名称(源分发,鸡蛋,转盘)。这是人们在setup(name='distribution')
电话中加入的名字。
让我展示详细的真实示例。我一直在维护一个名为CheetahTemplate的模板库。我在名为cheetah3/
的开发目录中进行开发。 PyPI上的分布称为Cheetah3;这就是我在setup(name='Cheetah3')
中输入的名称。顶层模块是Cheetah
,因此一个模块是import Cheetah.Template
或from Cheetah import Template
;这意味着我有一个目录cheetah3/Cheetah/
。
对2的答案是:您不能在存储库名称和PyPI发行名称中使用破折号,但在包(具有__init__.py
文件的目录)和模块(.py
文件)中不能包含破折号在Python import xy-zzy
中,这将是减法和SyntaxError
。
第3点:站点和存储库名称分别为scikit-learn
和distribution name,但可导入的程序包(带有__init__.py
的顶级目录)为{{3 }}。
PEP 8与该问题无关,因为它不讨论分发,只涉及可导入的程序包和模块。