[python3] python3的setup.py文件编写记录

首先我的项目结构如下

.
├── README.assets
│   └── 157_modify.webp
├── README.md
├── api_demo
│   ├── get_album.json
│   ├── get_albums.json
│   └── get_full_tree.json
├── requirements.txt
├── setup.py
├── src
│   ├── __init__.py
│   ├── lychee-cli.py
│   └── pychee6.py
└── tmp

以及setup.py结构如下

from setuptools import setup

requirements = open("requirements.txt").read().split("\n")

setup(
    name="pychee6",
    version="0.0.1",
    description="A simple python moudle for Lychee",
    long_description=open("README.md", "rt").read(),
    author="x1nt",
    author_email="cjdty@qq.com",
    url="https://github.com/x1ntt/pychee6",
    packages=["pychee6"],
    package_dir={"pychee6": "src"},
    include_package_data=True,
    install_requires=requirements
)

其中按照其中的参数名大概就能理解其中的意思了，对于比较关键的几个

• packages表示提供了哪些包，是逻辑名（用于在site-packages中创建目录）

  需要注意的是，这里可以支持find_packages()函数用于自动查找包，目标目录中需要包含__init__，所在目录名即为包名，可以看最后的参考

• package_dir表示这些包对应的具体目录是什么

• include_package_data表示其中会包含一些不是代码的文件

• install_requires是个列表，表示通过pip安装时一起安装的依赖包

此外src/__init__.py中的内容为

from .pychee6 import LycheeClient

参考自：winfspy/setup.py at master · Scille/winfspy