我应该在哪里放置Python包的演示脚本?

时间:2011-10-06 07:30:13

标签: python package main demo convention

我正在编写一个新的python包供别人使用。为了演示如何使用它,我正在编写一个演示脚本来执行新包的主要部分。

执行此操作的惯例是什么,以便其他人可以轻松找到脚本?它应该是一个单独的模块(以什么名称)?它应该位于包的根目录中吗?出包裹?在__init__.py

2 个答案:

答案 0 :(得分:3)

  

它应该是一个单独的模块(以什么名称)?

演示/ some_useful_name.py

演示目录包含演示脚本。同样,测试目录包含所有单元测试。

  

它应该位于包的根目录中吗?

没有。它不是包的一部分。这是一个演示。

  

打包了吗?

  

init .py?

从不。


一个包有两条命。 (1)作为已卸载的源,(2)在lib / site-packages中作为已安装的代码。

“source”应该包括README,setup.py,demo目录,测试目录和包本身。

顶级“源”setup.py应该只安装包。演示和测试没有安装。作为下载的一部分,它们会被遗忘。

答案 1 :(得分:2)

我从来没有见过任何真正的约定,但我个人把它放在__init__.py内的主要哨兵中,以便可以通过python -m somepackage调用它。