Python包管理工具setuptools之setup函数参数

Python包管理工具setuptools之setup函数参数详解

**********************************************************对所学内容的简单汇总*******************************************************
在安装python依赖库时，我们使用pip install 或者python setup.py install。
pip 会自己搜索适合的版本，python setup.py 需要下载源码本地安装。但是python setup.py 适合一键打包安装。

setup函数包含的参数解释
--name 包名称------------生成的egg名称
--version (-V) 包版本----生成egg包的版本号
--author 程序的作者------包的制作者名字
--author_email 程序的作者的邮箱地址
--maintainer 维护者
--maintainer_email 维护者的邮箱地址
--url 程序的官网地址
--license 程序的授权信息
--description 程序的简单描述-------程序的概要介绍
--long_description 程序的详细描述---程序的详细描述
--platforms 程序适用的软件平台列表
--classifiers 程序的所属分类列表
--keywords 程序的关键字列表
--packages 需要处理的包目录（包含__init__.py的文件夹）-------和setup.py同一目录下搜索各个含有 init.py的包
--py_modules 需要打包的python文件列表
--download_url 程序的下载地址
--cmdclass
--data_files 打包时需要打包的数据文件，如图片，配置文件等
--scripts 安装时需要执行的脚步列表
--package_dir 告诉setuptools哪些目录下的文件被映射到哪个源码包。一个例子：package_dir = {'': 'lib'}，表示“root package”中的模块都在lib 目录中。
--requires 定义依赖哪些模块
--provides定义可以为哪些模块提供依赖
--find_packages() 对于简单工程来说，手动增加packages参数很容易，刚刚我们用到了这个函数，它默认在和setup.py同一目录下搜索各个含有 init.py的包。
其实我们可以将包统一放在一个src目录中，另外，这个包内可能还有aaa.txt文件和data数据文件夹。另外，也可以排除一些特定的包
find_packages(exclude=[".tests", ".tests.", "tests.", "tests"])
--install_requires = ["requests"] 需要安装的依赖包
--entry_points 动态发现服务和插件

样例1如下：
from setuptools import setup, find_packages
setup(
name="prml",
version="0.0.1",
description="Collection of PRML algorithms",
author="ctgk",
python_requires=">=3.6",
install_requires=["numpy", "scipy"],#需要安装的依赖
packages=find_packages(exclude=["test", "test.*"]), # 需要打包的package,使用find_packages 来动态获取package，exclude参数的存在，使打包的时候，排除掉这些文件
test_suite="test"
)

样例2如下：
个人对使用packages相关参数的看法，
首先告诉程序去哪个目录中找包，因此有了packages参数，
其次，告诉程序我包的起始路径是怎么样的，因此有了package_dir参数
最后，找到包以后，我应该把哪些文件打到包里面，因此有了package_data参数
setup(
name = "demo",
version = "0.1",
# 包含所有src目录下的包 ---------项目中的所有源码和测试用例文件目录一般都存放在统一的src目录下方便管理，默认也是创建src目录
packages = find_packages('src'),
package_dir = {'':'src'},
package_data = {
# 包含所有.txt文件
'':['*.txt'],
# 包含data目录下所有的.dat文件
'test':['data/*.dat'],
}
)

 

我的现场打包：

环境：

(brains) [root@XM brains]# cat env.sh
source /opt/anaconda/bin/activate brns
source /root/.bash_profile
export LD_LIBRARY_PATH=/opt/anaconda/envs/brns/lib:$LD_LIBRARY_PATH
export PYTHONPATH=/app/brns
export FLASK_APP=brains/app.py
export FLASK_SETTINGS=ShipSettings
export NLS_LANG="AMERICAN_AMERICA.UTF8"

conda和pip环境：

(brains) [root@XM brains]# cat requirements.txt 
# -*- coding: utf-8 -*-

Flask>=1.0.2
Flask-CORS
Flask-SQLAlchemy
PyMongo
celery==4.0.2
kombu==4.0.2
cx_Oracle
SQLAlchemy
gunicorn
gevent
flower==0.9.1
retry
blinker

marshmallow==2.15.3
marshmallow-sqlalchemy==0.14.0
python_dateutil
PyYAML
apispec<0.39
xlrd
flask-session
pandas
redis
pytest
sqlparse
paramiko
python-slugify
python-crontab
cython
flask_principal
flask_login
requests
JayDeBeApi
dicttoxml
xmltodict
pika
jmespath
lxml
# Elasticsearch 6.x
elasticsearch>=6.0.0,<7.0.0
blinker
cron_descriptor

(brains) [root@XM brains]# cat environment.yaml 
name: brns
channels:
  - defaults
dependencies:
  - asn1crypto=0.24.0=py36_0
  - atomicwrites=1.2.1=py36_0
  - attrs=18.2.0=py36h28b3542_0
  - blinker=1.4=py36_0
  - ca-certificates=2018.03.07=0
  - certifi=2018.10.15=py36_0
  - cffi=1.11.5=py36h74b6da3_1
  - chardet=3.0.4=py36_1
  - colorama=0.4.0=py36_0
  - cryptography=2.4.1=py36h7a1dbc1_0
  - elasticsearch=6.3.1=py36_0
  - idna=2.7=py36_0
  - libiconv=1.15=h1df5818_7
  - libxml2=2.9.8=hadb2253_1
  - libxslt=1.1.32=hf6f1972_0
  - lxml=4.2.5=py36hef2cd61_0
  - more-itertools=4.3.0=py36_0
  - openssl=1.1.1a=he774522_0
  - oracle-instantclient=11.2.0.4.0=1
  - pip=18.1=py36_0
  - pluggy=0.6.0=py36_0
  - py=1.7.0=py36_0
  - pycparser=2.19=py36_0
  - pyopenssl=18.0.0=py36_0
  - pysocks=1.6.8=py36_0
  - pytest=3.6.2=py36_0
  - python=3.6.7=h33f27b4_1
  - requests=2.20.1=py36_0
  - setuptools=40.6.2=py36_0
  - six=1.11.0=py36_1
  - urllib3=1.23=py36_0
  - vc=14.1=h0510ff6_4
  - vs2015_runtime=14.15.26706=h3a45250_0
  - wheel=0.32.3=py36_0
  - win_inet_pton=1.0.1=py36_1
  - wincertstore=0.2=py36h7fe50ca_0
  - zlib=1.2.11=h8395fce_2
  - pip:
    - amqp==2.3.2
    - apispec==0.38.0
    - babel==2.6.0
    - bcrypt==3.1.4
    - billiard==3.5.0.4
    - celery==4.2.1
    - click==7.0
    - cron-descriptor==1.2.21
    - cx-oracle==7.0.0
    - cython==0.29
    - decorator==4.3.0
    - dicttoxml==1.7.4
    - fabric==2.4.0
    - flask==1.0.2
    - flask-cors==3.0.7
    - flask-login==0.4.1
    - flask-session==0.3.1
    - flask-sqlalchemy==2.3.2
    - flower==0.9.2
    - gevent==1.3.7
    - greenlet==0.4.15
    - gunicorn==19.9.0
    - ibm-db==2.0.9
    - invoke==1.2.0
    - itsdangerous==1.1.0
    - jaydebeapi==1.1.1
    - jinja2==2.10
    - jmespath==0.9.3
    - jpype1==0.6.3
    - kombu==4.2.1
    - markupsafe==1.1.0
    - marshmallow==2.15.3
    - marshmallow-sqlalchemy==0.14.0
    - numpy==1.15.4
    - pandas==0.23.4
    - paramiko==2.4.1
    - pyasn1==0.4.4
    - pymongo==3.7.2
    - pynacl==1.3.0
    - python-crontab==2.3.5
    - python-dateutil==2.7.5
    - pytz==2018.7
    - pyyaml==3.13
    - redis==3.0.1
    - retry==0.9.2
    - slugify==0.0.1
    - sqlalchemy==1.2.14
    - sqlparse==0.2.4
    - tornado==5.1.1
    - vine==1.1.4
    - werkzeug==0.14.1
    - xmltodict==0.11.0
prefix: C:\ProgramData\Anaconda3\envs\brns

con大环境

/opt/anaconda/envs/brns

【conda activate brains】

pip install setuptools

pip install Cython

打包脚本

from setuptools import setup
from Cython.Build import cythonize
import os

def find_res(root, ext='.py', excludes=None):
    all_pys = []
    for dirpath, dirnames, filenames in os.walk(root):
        for filename in filenames:
            if filename in excludes:
                continue
            if filename.endswith(ext):
                all_pys.append(os.path.join(dirpath, filename))

        for dirname in dirnames:
            all_pys.extend(find_res(os.path.join(dirpath, dirname), ext, excludes))

    return all_pys

res = find_res('brains', excludes=('settings.py', 'ta.py', 'tb.py'))
setup(
    name='brns',
    python_requires='>=3.7.0',
    ext_modules=cythonize(res),
    packages=['brns'],

)