setup.py示例？

Question

学习本页后:

http://docs.python.org/distutils/builtdist.html

我希望找到一些setup.py文件来研究,以便自己制作(目标是制作fedora rpm文件).

社区能指出一些好的例子吗？

Answer 1

在这里完成编写setup.py脚本的演练.(举几个例子)

如果你想要一个真实世界的例子,我可以指出你setup.py几个主要项目的脚本.Django就在这里,pyglet就在这里.您可以浏览名为setup.py的文件的其他项目的源代码以获取更多示例.

这些不是简单的例子; 我给出的教程链接有那些.这些更复杂,但也更实用.

Answer 2

您可能会发现HitchHiker的包装指南很有帮助,即使它不完整.我将从快速入门教程开始.还可以尝试浏览Python Package Index上的Python包.只需下载tarball,解压缩,然后查看setup.py文件.或者更好的是,只需查看列出公共源代码存储库的软件包,例如在GitHub或BitBucket上托管的软件包.你必须在头版遇到一个.

我最后的建议就是去尝试制作一个; 不要害怕失败.在我开始制作它们之前,我真的不理解它.在PyPI上创建一个新包并轻松删除它是微不足道的.所以,创建一个虚拟包并玩转.

Answer 3

请先阅读 https://packaging.python.org/en/latest/current.html

安装工具建议

1. 使用pip从PyPI安装Python包.
2. 使用virtualenv或pyvenv从共享的Python安装中隔离特定于应用程序的依赖项.
3. 使用pip轮创建车轮分布缓存,以便>加速后续安装.
4. 如果您正在寻找完全集成的跨平台软件堆栈的管理,请考虑构建(主要关注Web开发社区)或Hashdist或conda(主要关注于科学社区).

包装工具建议

1. 使用setuptools定义项目并创建源分发.
2. 使用车轮项目中提供的bdist_wheel setuptools扩展来创建车轮.如果您的项目包含二进制扩展,这尤其有用.
3. 使用twine将分发上传到PyPI.

这个anwser老了,确实有一个叫做蟒蛇包装世界的救援计划

轮子方式

我在这里qoute pythonwheels.com:

什么是轮子？

轮子是python分布的新标准,旨在取代鸡蛋.支持以pip> = 1.4和setuptools> = 0.8提供.

车轮的优点

1. 更快地安装纯python和本机C扩展包.
2. 避免安装任意代码执行.(避免setup.py)
3. 安装C扩展不需要Windows或OS X上的编译器.
4. 允许更好的缓存进行测试和持续集成.
5. 创建.pyc文件作为安装的一部分,以确保它们与使用的python解释器匹配.
6. 跨平台和机器的更一致的安装.

正确的python包装(约车轮)的整个故事是在覆盖packaging.python.org

康达的方式

对于科学计算(这也建议在packaging.python.org,见上文)我会考虑使用CONDA打包,可以看作是在PyPI和pip工具之上构建的第三方服务.它也可以很好地设置你自己的binstar版本,所以我想它可以解决复杂的自定义企业包管理问题.

Conda可以安装到一个用户文件夹(没有超级用户permisssions),并像魔术一样工作

conda安装

和强大的虚拟环境扩展.

鸡蛋的方式

这个选项与python-distribute.org有关,并且已经过时了(以及网站),所以让我指出一个我喜欢的即用型紧凑的setup.py示例:

• 将脚本和单个python文件混合到setup.py中的一个非常实用的示例/实现在这里给出
• 来自hyperopt的更好的一个

该引用来自于setup.py状态的指南,仍然适用:

• setup.py不见了!
• distutils走了!
• 分发了!
• pip和virtualenv留在这里!
• 鸡蛋......走了!

我再加一点(来自我)

• 轮子!

我建议在尝试无意识的复制粘贴之前,先了解包装生态系统(来自gotgenes指出的指南).

互联网上的大多数例子都是从那里开始的

from distutils.core import setup

但是这例如不支持构建一个egg python setup.py bdist_egg(以及其他一些旧功能),这些功能可以在

from setuptools import setup

原因是他们被弃用了.

现在根据指南

警告

请使用Distribute包而不是Setuptools包,因为此包中存在可以修复和不修复的问题.

不推荐使用的setuptools将被distutils2取代,它将"成为Python 3.3中标准库的一部分".我必须说我喜欢setuptools和egg,并且还没有完全相信distutils2的便利性.这个需要

pip install Distutils2

并安装

python -m distutils2.run install

PS

包装从来都不是微不足道的(一个人通过尝试开发一个新的方法来学习),所以我认为很多事情都是有道理的.我希望这次它能够正确完成.

Answer 4

这是我编写的实用程序，用于生成一个简单的setup.py文件（模板），其中包含有用的注释和链接。我希望，它会有用。

安装

sudo pip install setup-py-cli

用法

要生成setup.py文件，只需在终端中输入即可。

setup-py

现在setup.py文件应该出现在当前目录中。

生成的setup.py

from distutils.core import setup
from setuptools import find_packages
import os


# User-friendly description from README.md
current_directory = os.path.dirname(os.path.abspath(__file__))
try:
    with open(os.path.join(current_directory, 'README.md'), encoding='utf-8') as f:
        long_description = f.read()
except Exception:
    long_description = ''

setup(
    # Name of the package
    name=<name of current directory>,

    # Packages to include into the distribution
    packages=find_packages('.'), 

    # Start with a small number and increase it with every change you make
    # https://semver.org
    version='1.0.0',

    # Chose a license from here: https://help.github.com/articles/licensing-a-repository
    # For example: MIT
    license='',

    # Short description of your library
    description='',

    # Long description of your library
    long_description = long_description,
    long_description_context_type = 'text/markdown',

    # Your name
    author='', 

    # Your email
    author_email='',     

    # Either the link to your github or to your website
    url='',

    # Link from which the project can be downloaded
    download_url='',

    # List of keyword arguments
    keywords=[],

    # List of packages to install with this one
    install_requires=[],

    # https://pypi.org/classifiers/
    classifiers=[]  
)

生成的setup.py内容：

• 根据当前目录的名称自动填充包名称。
• 一些需要完成的基本领域。
• 澄清评论和有用资源的链接。
• 自动插入README.md中的描述，如果没有README.md则插入空字符串。

这是存储库的链接。自由填充以增强解决方案。

Answer 5

我建议setup.py中的Python的包装用户手册的示例项目。

《 Python打包用户指南》“旨在成为有关如何使用当前工具打包，发布和安装Python发行版的权威资源”。

Answer 6

查看一个完整的示例，该示例是一个小型python包的https://github.com/marcindulak/python-mycli。它基于https://packaging.python.org/en/latest/distributing.html上的打包建议，将setup.py与distutils结合使用，此外还展示了如何创建RPM和deb软件包。

该项目的setup.py包含在下面（完整信息请参见回购）：

#!/usr/bin/env python

import os
import sys

from distutils.core import setup

name = "mycli"

rootdir = os.path.abspath(os.path.dirname(__file__))

# Restructured text project description read from file
long_description = open(os.path.join(rootdir, 'README.md')).read()

# Python 2.4 or later needed
if sys.version_info < (2, 4, 0, 'final', 0):
    raise SystemExit, 'Python 2.4 or later is required!'

# Build a list of all project modules
packages = []
for dirname, dirnames, filenames in os.walk(name):
        if '__init__.py' in filenames:
            packages.append(dirname.replace('/', '.'))

package_dir = {name: name}

# Data files used e.g. in tests
package_data = {name: [os.path.join(name, 'tests', 'prt.txt')]}

# The current version number - MSI accepts only version X.X.X
exec(open(os.path.join(name, 'version.py')).read())

# Scripts
scripts = []
for dirname, dirnames, filenames in os.walk('scripts'):
    for filename in filenames:
        if not filename.endswith('.bat'):
            scripts.append(os.path.join(dirname, filename))

# Provide bat executables in the tarball (always for Win)
if 'sdist' in sys.argv or os.name in ['ce', 'nt']:
    for s in scripts[:]:
        scripts.append(s + '.bat')

# Data_files (e.g. doc) needs (directory, files-in-this-directory) tuples
data_files = []
for dirname, dirnames, filenames in os.walk('doc'):
        fileslist = []
        for filename in filenames:
            fullname = os.path.join(dirname, filename)
            fileslist.append(fullname)
        data_files.append(('share/' + name + '/' + dirname, fileslist))

setup(name='python-' + name,
      version=version,  # PEP440
      description='mycli - shows some argparse features',
      long_description=long_description,
      url='https://github.com/marcindulak/python-mycli',
      author='Marcin Dulak',
      author_email='X.Y@Z.com',
      license='ASL',
      # https://pypi.python.org/pypi?%3Aaction=list_classifiers
      classifiers=[
          'Development Status :: 1 - Planning',
          'Environment :: Console',
          'License :: OSI Approved :: Apache Software License',
          'Natural Language :: English',
          'Operating System :: OS Independent',
          'Programming Language :: Python :: 2',
          'Programming Language :: Python :: 2.4',
          'Programming Language :: Python :: 2.5',
          'Programming Language :: Python :: 2.6',
          'Programming Language :: Python :: 2.7',
          'Programming Language :: Python :: 3',
          'Programming Language :: Python :: 3.2',
          'Programming Language :: Python :: 3.3',
          'Programming Language :: Python :: 3.4',
      ],
      keywords='argparse distutils cli unittest RPM spec deb',
      packages=packages,
      package_dir=package_dir,
      package_data=package_data,
      scripts=scripts,
      data_files=data_files,
      )

和RPM规范文件（或多或少遵循Fedora / EPEL包装指南）可能类似于：

# Failsafe backport of Python2-macros for RHEL <= 6
%{!?python_sitelib: %global python_sitelib      %(%{__python} -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())")}
%{!?python_sitearch:    %global python_sitearch     %(%{__python} -c "from distutils.sysconfig import get_python_lib; print(get_python_lib(1))")}
%{!?python_version: %global python_version      %(%{__python} -c "import sys; sys.stdout.write(sys.version[:3])")}
%{!?__python2:      %global __python2       %{__python}}
%{!?python2_sitelib:    %global python2_sitelib     %{python_sitelib}}
%{!?python2_sitearch:   %global python2_sitearch    %{python_sitearch}}
%{!?python2_version:    %global python2_version     %{python_version}}

%{!?python2_minor_version: %define python2_minor_version %(%{__python} -c "import sys ; print sys.version[2:3]")}

%global upstream_name mycli


Name:           python-%{upstream_name}
Version:        0.0.1
Release:        1%{?dist}
Summary:        A Python program that demonstrates usage of argparse
%{?el5:Group:       Applications/Scientific}
License:        ASL 2.0

URL:            https://github.com/marcindulak/%{name}
Source0:        https://github.com/marcindulak/%{name}/%{name}-%{version}.tar.gz

%{?el5:BuildRoot:   %(mktemp -ud %{_tmppath}/%{name}-%{version}-%{release}-XXXXXX)}
BuildArch:      noarch

%if 0%{?suse_version}
BuildRequires:      python-devel
%else
BuildRequires:      python2-devel
%endif


%description
A Python program that demonstrates usage of argparse.


%prep
%setup -qn %{name}-%{version}


%build
%{__python2} setup.py build


%install
%{?el5:rm -rf $RPM_BUILD_ROOT}
%{__python2} setup.py install --skip-build --prefix=%{_prefix} \
   --optimize=1 --root $RPM_BUILD_ROOT


%check
export PYTHONPATH=`pwd`/build/lib
export PATH=`pwd`/build/scripts-%{python2_version}:${PATH}
%if 0%{python2_minor_version} >= 7
%{__python2} -m unittest discover -s %{upstream_name}/tests -p '*.py'
%endif


%clean
%{?el5:rm -rf $RPM_BUILD_ROOT}


%files
%doc LICENSE README.md
%{_bindir}/*
%{python2_sitelib}/%{upstream_name}
%{?!el5:%{python2_sitelib}/*.egg-info}


%changelog
* Wed Jan 14 2015 Marcin Dulak <X.Y@Z.com> - 0.0.1-1
- initial version

Answer 7

最小的例子

from setuptools import setup, find_packages


setup(name='foo',
      version='1.0',
      packages=find_packages(),
      )