如何创建 python 2.x 包 - 简单案例

Question

请展示为 python 2.x 创建 python 包的简单且最新的标准方法

以后我更喜欢使用 pip 来安装包。

包应该包含一个类：

class hello:
  def greet(self):
    print "hello"

以后应该可以做到以下几点：

pip install my_package-0.1.1....

然后使用它：

from my_package import hello

h = hello.hello()
h.greet()

我要的是：

• 目录和文件布局
• 文件内容
• 创建可分发包文件的命令
• 从可分发包文件安装包的命令（最好使用 pip）

我找到了几个howtos，但我仍然不确定如何处理这个非常简单且精简的案例（没有嵌套包，删除所有文件和功能，对于最简单的案例可以省略），以及哪个是现代的方式。

我希望这个问题进入社区 wiki 状态，所以你不会得到任何分数，我会给予足够的时间，并会在几天后将答案标记为接受，同时考虑投票和 cmets。

编辑：

我想分享第一个正在运行的示例，我使用了 Marius Gedminas 的答案。它不包含应该存在的所有内容，但它确实有效，因此它可以展示技术流程的核心。要添加更多必要的部分，请阅读下面 Marius 的回答。

目录结构：

MyProject/
    setup.py
    my_package.py
    README.txt
    MANIFEST.in

setup.py：

from setuptools.import setup
setup(name='MyProject',
      version='0.1',
      py_modules=['my_package'])

my_package.py：

class hello:
  def greet(self):
    print "hello"

MANIFEST.in：

include *.txt

要从此文件夹创建包，请进入文件夹 MyProject 并运行：

$ python setup.py sdist

这将在子文件夹dist/ 中创建一个文件MyProject-0.1.tar.gz。将此文件复制到目标计算机上的文件夹中。

在目标机器上，在包含MyProject-0.1.tar.gz的文件夹中运行此命令：

sudo pip install MyProject-0.1.tar.gz

现在可能需要在目标机器上注销并重新登录，这样才能找到包。之后，您可以使用 python shell 在目标机器上测试该包：

$ python
>>> import my_package
>>> h = my_package.hello()
>>> h.greet()
hello
>>> 

一旦成功，请记得添加其他必要的内容，请参阅下面 Marius 的回答。

Answer 1

从简单开始

最简单的一文件包：

MyProject/
    setup.py
    my_package.py

最简单的 setup.py：

from setuptools import setup
setup(name='MyProject',
      version='0.1',
      author='Your Name',
      author_email='your.name@example.com',
      license='MIT',
      description='Example package that says hello',
      py_modules=['my_package'])

在包中包含额外的文件

接下来你可能应该添加一个自述文件：

MyProject/
    MANIFEST.in
    README.rst
    setup.py
    my_package.py

注意新文件 -- MANIFEST.in。它指定哪些非 Python 文件应该包含在您的源代码分发中：

include *.rst

人们会告诉你“哦，跳过清单，只需将文件添加到源代码管理，setuptools 就会找到它们”。忽略这个建议，太容易出错了。

让 PyPI 页面变得有用

让人们可以在 Python 包索引上在线查看 README.rst 很有用。所以改变你的 setup.py 来做

from setuptools import setup
with open('README.rst') as f:
    readme = f.read()
setup(name='MyProject',
      ...
      description='Example package that says hello',
      long_description=readme,
      ...)

对更漂亮的页面使用ReStructuredText 标记。使用

python setup.py --long-description | rst2html

尽早发现 ReStructuredText 错误。

一个包中有多个 Python 模块

一个文件很快就不够用了，所以将其更改为一个包（混淆术语警告：Python 包在带有__init__ py 的目录中，而不是在可分发的自包含存档中）：

MyProject/
    MANIFEST.in
    README.rst
    setup.py
    my_package/
        __init__.py
        some_module.py

并将 setup.py 更改为

from setuptools import setup, find_packages
with open('README.rst') as f:
    readme = f.read()
setup(name='MyProject',
      version='0.2',
      author='Your Name',
      author_email='your@email',
      license='MIT',
      description='Example package that says hello',
      long_description=readme,
      packages=find_packages())

向公众发布

Get a PyPI account -- 你只需要这样做一次。

要发布，请确保 setup.py 中的版本号正确，然后运行

python setup.py sdist register upload

就是这样。

告诉人们安装它

告诉他们

pip install MyProject

（与您在 setup.py 中指定的名称与 setup() 的 name 参数相同）

Answer 2

以下内容抄自Distutils Tutorial。

文件布局：

top
|-- package
|   |-- __init__.py
|   |-- module.py
|   `-- things
|       |-- cross.png
|       |-- fplogo.png
|       `-- tick.png
|-- runner
|-- MANIFEST.in
|-- README
`-- setup.py

要制作安装压缩包，您只需运行：

python setup.py sdist

要安装软件包，请使用pip 或easy_install：

pip install my_package-1.2.3.tar.bz2

或

easy_install my_package-1.2.3.tar.bz2

也可以上传到PyPI，先注册一下：

python setup.py register

然后上传源压缩包

python setup.py sdist upload

你也可以上传二进制鸡蛋（虽然不是必须的）：

python setup.py bdist_egg upload

然后人们可以像这样安装它：

pip install my_package==1.2.3

或者，

easy_install my_package==1.2.3