GVKun编程网logo

如何在Python 2.7中使用“ setup.cfg”代替setup.py(python中的setup怎么用)

21

本文的目的是介绍如何在Python2.7中使用“setup.cfg”代替setup.py的详细情况,特别关注python中的setup怎么用的相关信息。我们将通过专业的研究、有关数据的分析等多种方式,

本文的目的是介绍如何在Python 2.7中使用“ setup.cfg”代替setup.py的详细情况,特别关注python中的setup怎么用的相关信息。我们将通过专业的研究、有关数据的分析等多种方式,为您呈现一个全面的了解如何在Python 2.7中使用“ setup.cfg”代替setup.py的机会,同时也不会遗漏关于Python Setup.py、python setup.py 卸载、python setup.py 构建、python setup.py 浅析的知识。

本文目录一览:

如何在Python 2.7中使用“ setup.cfg”代替setup.py(python中的setup怎么用)

如何在Python 2.7中使用“ setup.cfg”代替setup.py(python中的setup怎么用)

在我看来distutils.core.setup,可以使用该setup.cfg文件所在的目录来代替该函数的大量命名关键字参数,setup.py而所有这些关键字都将从setup.cfg文件中读取。

我以为我可以setup.cfg用Python 2.7来简单地创建一个,但是最低的测试版本是行不通的。我确实使用进行了测试setup.py --name,该测试仅返回:UNKNOWN

而且,像往常一样,使用python打包时,文档总是令人困惑,因为永远不清楚,它们与哪个版本有关,或者至少是文档多久了。

我的两个安装文件:

setup.py:

from distutils.core import setup
setup()

setup.cfg:

[metadata]
name = foo
version = 0.1

我调查了distutils程序包,发现(除了像地狱一样笨拙)它似乎使用mail.message_from_file工厂来读取setup.cfg

因为我对setup.py仅使用方法很满意,所以我不会再胡说八道了,但是我仍然很好奇如何正确地做,如果有可能的话。

无论是官方的包装文档还是包装,当局似乎是一个很大的帮助在这里。


几乎每次我感到不得不研究python 2.x stdlib时,我都想知道他们是否试图展示如何不编程。 另一方面,C代码看起来很漂亮。

Python Setup.py

Python Setup.py

所以我是 python建筑和包装的新手.

我很困惑我的设置是否可行,以及是否有更好的方法来构建代码文件以实现更好的打包.

从本质上讲,我有:

/top_folder/
|___setup.py
|___file1.py
|___file2.py
|___lib/                        <--- (FOLDER)
    |_____ binary1
    |_____ libfile1.py
    |_____ libfile2.awk
    |_____ __init__.py

这样的setup.py文件是正确的方法吗?

setup(
    name=''myName'',version=''1.0a'',#packages=[''lib''],url=''http://myUrl.co.uk'',license=''GPL2'',author=''myAuthorName'',author_email=''myAuthorEmail'',description=''myDescription'',py_modules=[''file1'',''file2'']
)

解决方法

也许这篇 Open Sourcing a Python Project the Right Way的帖子可能有所帮助.它不仅包括setup.py文件,还包括几乎所有工具和概念.

python setup.py 卸载

python setup.py 卸载

我已经安装了一个带有python setup.py install.

我该如何卸载它?

python setup.py 构建

python setup.py 构建

摘要:这篇文章描述了自己动手把需要的代码封装成python模块的方法。完成后,我们可以直接使用pip install xxx下载自己的模块并使用内置的函数。

介绍
python作为一门鼎鼎大名的语言,最有优势的地方就是它拥有无数第三方的模块可以直接拿来使用。以numpy(一个用于实现科学计算的模块)为例,常见的用法一般是这样,相信写过python的肯定是见得多了。

import numpy
from numpy import core

要使用这样外部的模块,我们通常使用pip install或者 easy_install 命令安装相关的外部文件。这个命令实际上是从python的资源管理库中下载需要的python模块。

使用python包模块有很多好处:

可以使用pip之类的命令来管理和安装python模块,避免手动管理引用文件。
方便共享我们的python包。
在一个模块中可以添加文档。
在python包与包之间有很多的相互依赖,引入包模块可以预先加载所有需要的包,避免由于模块之间依赖造成的问题。
最近在导师的一个项目里,需要从一个复杂的json格式的文件中提取大量格式化数据。为了方便重复的数据提取,我写了一个python模块,于是记录一下整个把自己写的python包发布到pip资源管理站上的过程。

注意:这个发布的过程只在python 2.7版本上经过测试,对于python 3.x 版本可能会有错误。请谨慎使用。

创建pip目录结构
要把自己的包发布到pip上,需要满足以下几个条件:

目录下的所有文件名均为英文小写
不包含下划线,空格和特殊字符
选定的包名在pypi网站上没有使用过,可以访问官网,搜索一下想用的名字有没有被占用。
我的python包名叫做clinicaltrial,目录结构如下:我们先创建空文件,指定以下的名字

clinicaltrial/
clinicaltrial/
__init__.py
setup.py

其中主目录是整个包的根目录,setup.py是部署到pip需要的配置文件,子目录clinicaltrial是真正的python代码位置。
我们在__init__.py中写入代码:

def start():
print("import successful")

然后在setup.py文件中写入以下配置信息(参数里的内容可以修改,可以添加的参数具体可以参考python官方文档)

from setuptools import setup
setup(name=''clinicaltrial'',
version=''0.1'',
description=''clinical trial information retriver'',
url=''http://github.com/tongling/clinicaltrial'',
author=''Ling'',
author_email=''tonglingacademic@gmail.com'',
license=''MIT'',
packages=[''clinicaltrial'',''filter''],
zip_safe=False)

然后打开命令行,切换到当前目录,输入

pip install .


然后,在我们的系统上,就可以导入这个包了:

import clinicaltrial
clinicaltrial.start()

发布python模块
然后,我们在PyPI官网上发布我们的包。我的包在这里,可以先看一下。

首先我们登录官网,在右边菜单点击Register,注册一个账号。

然后在命令行中切换到当前目录,输入:

$ python setup.py sdist

这条命令会创建clinicaltrial-0.1.tar.gz文件,这个文件待会儿将上传到网站上。

然后输入命令,上传我们的文件:

$ python setup.py sdist upload

上传成功后,全世界所有人都可以使用pip下载你的包啦!只要输入

$ pip install clinicaltrial

就可以下载你的模块到任何python环境上。

小结
至此,用最简单的方法创建自己的python包,基本设置就完成了。但是想要让python包真正用起来,还需要增加这个包里面更多的内容。通常来说,在__init__.py编写一些初始运行脚本,增加包的使用文档和一些测试工具都是非常必要的内容。

今天就先到这里啦!后面我会介绍更多关于python之间模块依赖,.gitignore,以及编写模块测试的方法。玩的愉快!
————————————————
版权声明:本文为CSDN博主「童凌」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/tlonline/article/details/79751658

python setup.py 浅析

python setup.py 浅析

python setup.py 浅析

setuptools.setup() 参数说明

packages

对于所有 packages 列表里提到的纯 Python 模块做处理
需要在 setup 脚本里有一个包名到目录的映射。
默认对于 setup 脚本所在目录下同名的目录即视为包所在目录。
当你在 setup 脚本中写入 packages = [''foo''] 时, setup 脚本的同级目录下可以找到 foo/__init__.py。如果没有找到对应文件,disutils 不会直接报错,而是给出一个告警然后继续进行有问题的打包流程。

package_dir

阐明包名到目录的映射,见 packages

package_dir = {'''': ''lib''}

键: 代表了包的名字,空的包名则代表 root package(不在任何包中的顶层包)。
值: 代表了对于 setup 脚本所在目录的相对路径.

packages = [''foo'']
package_dir = {'''': ''lib''}

指明包位于 lib/foo/, lib/foo/__init__.py 这个文件存在

另一种方法则是直接将 foo 这个包的内容全部放入 lib 而不是在 lib 下建一个 foo 目录

package_dir = {''foo'': ''lib''}

一个在 package_dir 字典中的 package: dir 映射会对当前包下的所有包都生效, 所以 foo.bar 会自动生效. 在这个例子当中, packages = [''foo'', ''foo.bar''] 告诉 distutils 去寻找 lib/__init__.pylib/bar/__init__.py.

py_modules

对于一个相对较小的模块的发布,你可能更想要列出所有模块而不是列出所有的包,尤其是对于那种根目录下就是一个简单模块的类型.
这描述了两个包,一个在根目录下,另一个则在 pkg 目录下。
默认的“包:目录”映射关系表明你可以在 setup 脚本所在的路径下找到 mod1.py 和 pkg/mod2.py。
当然,你也可以用 package_dir 选项重写这层映射关系就是了。

find_packages

packages=find_packages(exclude=(''tests'', ''robot_server.scripts'')),
exclude 里面是包名,而非路径

include_package_data

引入包内的非 Python 文件
include_package_data 需要配合 MANIFEST.in 一起使用

MANIFEST.in:

include myapp/scripts/start.py
recursive-include myapp/static *
setup(
    name=''MyApp'',         # 应用名
    version=''1.0'',        # 版本号
    packages=[''myapp''],   # 包括在安装包内的Python包
    include_package_data=True    # 启用清单文件MANIFEST.in
)

注意,此处引入或者排除的文件必须是 package 内的文件

setup-demo/
  ├ mydata.data      # 数据文件
  ├ setup.py         # 安装文件
  ├ MANIFEST.in      # 清单文件
  └ myapp/           # 源代码
      ├ static/      # 静态文件目录
      ├ __init__.py
      ...

在 MANIFEST.in 引入 include mydata.data 将不起作用

exclude_package_date

排除一部分包文件
{''myapp'':[''.gitignore]},就表明只排除 myapp 包下的所有.gitignore 文件。

data_files

指定其他的一些文件(如配置文件)

data_files=[(''bitmaps'', [''bm/b1.gif'', ''bm/b2.gif'']),
            (''config'', [''cfg/data.cfg'']),
            (''/etc/init.d'', [''init-script''])]

规定了哪些文件被安装到哪些目录中。
如果目录名是相对路径(比如 bitmaps),则是相对于 sys.prefix(/usr) 或 sys.exec_prefix 的路径。
否则安装到绝对路径(比如 /etc/init.d )。

cmdclass

定制化命令,通过继承 setuptools.command 下的命令类来进行定制化

class UploadCommand(Command):
    """Support setup.py upload."""
    ...

    def run(self):
        try:
            self.status(''Removing previous builds…'')
            rmtree(os.path.join(here, ''dist''))
        except OSError:
            pass

        self.status(''Building Source and Wheel (universal) distribution…'')
        os.system(''{0} setup.py sdist bdist_wheel --universal''.format(sys.executable))

        self.status(''Uploading the package to PyPI via Twine…'')
        os.system(''twine upload dist/*'')

        self.status(''Pushing git tags…'')
        os.system(''git tag v{0}''.format(about[''__version__'']))
        os.system(''git push --tags'')

        sys.exit()

setup(
    ...
    # $ setup.py publish support.
    cmdclass={
        ''upload'': UploadCommand,
    },
)

这样可以通过 python setup.py upload 运行打包上传代码

install_requires

安装这个包所需要的依赖,列表

tests_require

与 install_requires 作用相似,单元测试时所需要的依赖

虚拟运行环境下安装包

以 legit 为例

  • 下载 lgit 源码
    git clone https://github.com/kennethreitz/legit.git
  • 创建虚拟运行环境
    virtualenv --no-site-packages venv
    运行环境目录结构为:

    venv/
    ├── bin
    ├── include
    ├── lib
    ├── local
    └── pip-selfcheck.json
  • 打包工程
    python3 setup.py sdist bdist_wheel

    .
    ├── AUTHORS
    ├── build
    │   ├── bdist.linux-x86_64
    │   └── lib.linux-x86_64-2.7
    ├── dist
    │   ├── legit-1.0.1-py2.py3-none-any.whl
    │   └── legit-1.0.1.tar.gz

    在 dist 下生成了安装包

  • 进入虚拟环境
    source venv/bin/activate
  • 安装包
    pip install ./dist/legit-1.0.1.tar.gz

    Successfully built legit args clint
    Installing collected packages: appdirs, args, click, lint, colorama, crayons, smmap2, gitdb2, GitPython, ix, pyparsing, packaging, legit
    Successfully installed GitPython-2.1.8 appdirs-1.4.3 rgs-0.1.0 click-6.7 clint-0.5.1 colorama-0.4.0 rayons-0.1.2 gitdb2-2.0.3 legit-1.0.1 packaging-17.1 yparsing-2.2.0 six-1.11.0 smmap2-2.0.3
    

安装过程分析

venv/lib/python2.7/site-packages/ 下安装了 legit 及依赖包

legit/venv/lib/python2.7/site-packages$ tree -L 1

.
├── appdirs-1.4.3.dist-info
├── appdirs.py
├── appdirs.pyc
├── args-0.1.0.dist-info
├── args.py
├── args.pyc
├── click
├── click-6.7.dist-info
├── clint
├── clint-0.5.1.dist-info
├── colorama
├── colorama-0.4.0.dist-info
├── crayons-0.1.2.dist-info
├── crayons.py
├── crayons.pyc
├── easy_install.py
├── easy_install.pyc
├── git
├── gitdb
├── gitdb2-2.0.3.dist-info
├── GitPython-2.1.8.dist-info
├── legit
├── legit-1.0.1.dist-info
├── packaging
├── packaging-17.1.dist-info
├── pip
├── pip-18.1.dist-info
├── pkg_resources
├── pyparsing-2.2.0.dist-info
├── pyparsing.py
├── pyparsing.pyc
├── setuptools
├── setuptools-40.6.2.dist-info
├── six-1.11.0.dist-info
├── six.py
├── six.pyc
├── smmap
├── smmap2-2.0.3.dist-info
├── wheel
└── wheel-0.32.2.dist-info

venv/bin 下新增可执行文件 legit, 内容为

#!/home/turtlebot/learn/python/legit/venv/bin/python

# -*- coding: utf-8 -*-
import re
import sys

from legit.cli import cli

if __name__ == ''__main__'':
    sys.argv[0] = re.sub(r''(-script\.pyw?|\.exe)?$'', '''', sys.argv[0])
    sys.exit(cli())

此时,可以直接运行

>>> legit

setup.py 分析

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import os
import sys
from codecs import open  # To use a consistent encoding

from setuptools import setup  # Always prefer setuptools over distutils

APP_NAME = ''legit''
APP_SCRIPT = ''./legit_r''
VERSION = ''1.0.1''


# Grab requirements.
with open(''reqs.txt'') as f:
    required = f.readlines()


settings = dict()


# Publish Helper.
if sys.argv[-1] == ''publish'':
    os.system(''python setup.py sdist bdist_wheel upload'')
    sys.exit()


if sys.argv[-1] == ''build_manpage'':
    os.system(''rst2man.py README.rst > extra/man/legit.1'')
    sys.exit()


# Build Helper.
if sys.argv[-1] == ''build'':
    import py2exe  # noqa
    sys.argv.append(''py2exe'')

    settings.update(
        console=[{''script'': APP_SCRIPT}],
        zipfile=None,
        options={
            ''py2exe'': {
                ''compressed'': 1,
                ''optimize'': 0,
                ''bundle_files'': 1}})

settings.update(
    name=APP_NAME,
    version=VERSION,
    description=''Git for Humans.'',
    long_description=open(''README.rst'').read(),
    author=''Kenneth Reitz'',
    author_email=''me@kennethreitz.com'',
    url=''https://github.com/kennethreitz/legit'',
    packages=[''legit''],
    install_requires=required,
    license=''BSD'',
    classifiers=[
        ''Development Status :: 5 - Production/Stable'',
        ''Intended Audience :: Developers'',
        ''Natural Language :: English'',
        ''License :: OSI Approved :: BSD License'',
        ''Programming Language :: Python'',
        ''Programming Language :: Python :: 2'',
        ''Programming Language :: Python :: 2.7'',
        ''Programming Language :: Python :: 3'',
        ''Programming Language :: Python :: 3.4'',
        ''Programming Language :: Python :: 3.5'',
        ''Programming Language :: Python :: 3.6'',
    ],
    entry_points={
        ''console_scripts'': [
            ''legit = legit.cli:cli'',
        ],
    }
)


setup(**settings)
  • packages=[''legit''] 引入 legit 目录下的所有默认引入文件
  • install_requires=required 指明安装时需要额外安装的第三方库
  • ''console_scripts'': [''legit = legit.cli:cli'',] 生成可执行控制台程序,程序名为 legit, 运行 legit.cli 中的 cli()函数。最终会在 bin/ 下生成 legit 可执行 py 文件,调用制定的函数

setup.py 实例分析

kennethreitz/setup.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

# Note: To use the ''upload'' functionality of this file, you must:
#   $ pip install twine

import io
import os
import sys
from shutil import rmtree

from setuptools import find_packages, setup, Command

# Package meta-data.
NAME = ''mypackage''
DESCRIPTION = ''My short description for my project.''
URL = ''https://github.com/me/myproject''
EMAIL = ''me@example.com''
AUTHOR = ''Awesome Soul''
REQUIRES_PYTHON = ''>=3.6.0''
VERSION = None

# What packages are required for this module to be executed?
REQUIRED = [
    # ''requests'', ''maya'', ''records'',
]

# What packages are optional?
EXTRAS = {
    # ''fancy feature'': [''django''],
}

# The rest you shouldn''t have to touch too much :)
# ------------------------------------------------
# Except, perhaps the License and Trove Classifiers!
# If you do change the License, remember to change the Trove Classifier for that!

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

# Import the README and use it as the long-description.
# Note: this will only work if ''README.md'' is present in your MANIFEST.in file!
try:
    with io.open(os.path.join(here, ''README.md''), encoding=''utf-8'') as f:
        long_description = ''\n'' + f.read()
except FileNotFoundError:
    long_description = DESCRIPTION

# Load the package''s __version__.py module as a dictionary.
about = {}
if not VERSION:
    with open(os.path.join(here, NAME, ''__version__.py'')) as f:
        exec(f.read(), about)
else:
    about[''__version__''] = VERSION


class UploadCommand(Command):
    """Support setup.py upload."""

    description = ''Build and publish the package.''
    user_options = []

    @staticmethod
    def status(s):
        """Prints things in bold."""
        print(''\033[1m{0}\033[0m''.format(s))

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        try:
            self.status(''Removing previous builds…'')
            rmtree(os.path.join(here, ''dist''))
        except OSError:
            pass

        self.status(''Building Source and Wheel (universal) distribution…'')
        os.system(''{0} setup.py sdist bdist_wheel --universal''.format(sys.executable))

        self.status(''Uploading the package to PyPI via Twine…'')
        os.system(''twine upload dist/*'')

        self.status(''Pushing git tags…'')
        os.system(''git tag v{0}''.format(about[''__version__'']))
        os.system(''git push --tags'')

        sys.exit()


# Where the magic happens:
setup(
    name=NAME,
    version=about[''__version__''],
    description=DESCRIPTION,
    long_description=long_description,
    long_description_content_type=''text/markdown'',
    author=AUTHOR,
    author_email=EMAIL,
    python_requires=REQUIRES_PYTHON,
    url=URL,
    packages=find_packages(exclude=(''tests'',)),
    # If your package is a single module, use this instead of ''packages'':
    # py_modules=[''mypackage''],

    # entry_points={
    #     ''console_scripts'': [''mycli=mymodule:cli''],
    # },
    install_requires=REQUIRED,
    extras_require=EXTRAS,
    include_package_data=True,
    license=''MIT'',
    classifiers=[
        # Trove classifiers
        # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
        ''License :: OSI Approved :: MIT License'',
        ''Programming Language :: Python'',
        ''Programming Language :: Python :: 3'',
        ''Programming Language :: Python :: 3.6'',
        ''Programming Language :: Python :: Implementation :: CPython'',
        ''Programming Language :: Python :: Implementation :: PyPy''
    ],
    # $ setup.py publish support.
    cmdclass={
        ''upload'': UploadCommand,
    },
)

关于如何在Python 2.7中使用“ setup.cfg”代替setup.pypython中的setup怎么用的问题我们已经讲解完毕,感谢您的阅读,如果还想了解更多关于Python Setup.py、python setup.py 卸载、python setup.py 构建、python setup.py 浅析等相关内容,可以在本站寻找。

本文标签: