setup.py示例?

时间:2011-01-19 20:42:24

标签: python rpm

学习本页后:

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

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

可以s.o.社区指出了一些好的例子?

8 个答案:

答案 0 :(得分:51)

撰写setup.py脚本here的完整演练。 (有一些例子)

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

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

答案 1 :(得分:29)

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

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

答案 2 :(得分:24)

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

  

安装工具建议

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

    包装工具建议

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

这个anwser已经老了,确实有一个名为

的蟒蛇包装世界的救援计划

轮子方式

我在这里问pythonwheels.com

  

什么是轮子?

     

车轮是python发行的新标准   并打算取代鸡蛋。支持以pip> = 1.4和   setuptools> = 0.8。

车轮的优点

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

    涵盖了正确的python包装(以及关于轮子)的完整故事

    conda way

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

    Conda可以安装到用户文件夹中(没有超级用户permisssions),并且像

    一样神奇
      

    conda install

    强大的虚拟环境扩展。


    鸡蛋方式

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

    • 在setup.py中混合脚本和单个python文件的一个非常实用的示例/实现是here
    • 来自hyperopt
    • 的更好的一个

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

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

    我再添加一点(来自我)

    • 车轮

    我建议在尝试无意识的复制粘贴之前先了解一下packaging-ecosystem(来自gotgenes指南)。

    互联网上的大多数示例都以

    开头
    from distutils.core import setup
    

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

    中找到
    from setuptools import setup
    

    原因是他们已弃用

    现在根据指南

      

    警告

         

    请使用Distribute包而不是Setuptools包   因为这个包中有问题可以,也可能不会   固定的。

    不推荐的setuptools将被distutils2取代,“{3}}将成为Python 3.3中标准库的一部分”。我必须说我喜欢setuptools和egg,并且还没有完全相信distutils2的便利性。它需要

    pip install Distutils2
    

    并安装

    python -m distutils2.run install
    

    <击>

    PS

    包装从来都不是微不足道的(人们通过尝试开发新的包装来了解这一点),所以我认为很多事情都是有道理的。我希望这次正确完成。

答案 3 :(得分:5)

我推荐setup.py示例项目的Python Packaging User Guide

Python Packaging用户指南&#34;旨在成为如何使用当前工具打包,发布和安装Python发行版的权威资源&#34;。

答案 4 :(得分:3)

在这里,您将找到使用distutils和setup.py的最简单的示例:

https://docs.python.org/2/distutils/introduction.html#distutils-simple-example

这假设您的所有代码都在一个文件中,并告诉您如何打包包含单个模块的项目。

答案 5 :(得分:3)

查看一个小python包的完整示例https://github.com/marcindulak/python-mycli。它基于https://packaging.python.org/en/latest/distributing.html的打包建议,使用带有distutils的setup.py,另外还展示了如何创建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

答案 6 :(得分:2)

这是我编写的实用程序,用于生成带有有用注释和链接的简单 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 ,则为空字符串。

这是存储库中的link。免费填充以增强解决方案。

答案 7 :(得分:1)

最小示例

from setuptools import setup, find_packages


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