草庐IT

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

coder 2023-05-26 原文

请展示为 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 状态,所以你不会得到任何分数,我会给予足够的时间,并会在几天后将答案标记为接受,同时考虑投票和评论。

编辑:

我想分享第一个正在运行的示例,我使用了 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 的回答。

最佳答案

从简单开始

最简单的一文件包:

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

人们会告诉你“哦,跳过 list ,只需将文件添加到源代码管理,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 参数相同)

关于python - 如何创建 python 2.x 包 - 简单案例,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/4155914/

有关python - 如何创建 python 2.x 包 - 简单案例的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 如何在 Ruby 中顺序创建 PI - 2

    出于纯粹的兴趣,我很好奇如何按顺序创建PI,而不是在过程结果之后生成数字,而是让数字在过程本身生成时显示。如果是这种情况,那么数字可以自行产生,我可以对以前看到的数字实现垃圾收集,从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法,类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

  4. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  5. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  6. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  7. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  8. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时,rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  9. ruby - 使用 Vim Rails,您可以创建一个新的迁移文件并一次性打开它吗? - 2

    使用带有Rails插件的vim,您可以创建一个迁移文件,然后一次性打开该文件吗?textmate也可以这样吗? 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件,这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails,您可以创建一个新的迁移文件并一次性打开它吗?,我们在StackOverflow上找到一个类似的问题: https://sta

  10. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件? - 2

    在选择我想要运行操作的频率时,唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案,但您可以安排它每天运行,并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/8692687/

随机推荐