setup.py

from setuptools import setup, find_packages

# 打包到pypi的详细链接：https://packaging.python.org/guides/distributing-packages-using-setuptools/
# python打包时的命名域的解释链接：https://packaging.python.org/guides/packaging-namespace-packages/
# setuptools打包说明链接：https://setuptools.readthedocs.io/en/latest/setuptools.html
# setup.py的例子(注意命名域)：https://github.com/pypa/sampleproject/blob/master/setup.py
#
# setup()中package_data（重点）、packages、data_files这三个参数要着重理解。
#
# 终端输入命令 python setup.py sdist 打包后先别急着上传到pypi，先在本地项目中的dist文件夹（打包生成的）
# 下查看打包后的文件 *.tar.gz，看看是否有你想要打包进的文件，再终端输入命令 twine upload dist/* 上传打包后的文件
# （如果电脑中没有twine命令，先pip install twine）。
#
# 上传项目到pypi后，有的python镜像源（如清华镜像源）需要等几天才能将pypi更新后的库收入到镜像仓库中，
# 用户如果输入 pip install cn_sort --upgrade 可能不会立马获得最新的库，除非切换下载源到pypi仓库。
#
# python setup.py bdist_wheel 命令是打包成纯（pure）wheel文件的，适用于特定的Linux, macOS, or Windows等平台。
#
# 当你决定要把打包后的文件上传到pypi时，setup()的version参数（版本号）一定要比之前更高，不然会出现400文件名重复的错误。
#
# 除了代码（.py）的额外文件（如.png、.db等数据文件）一定要在setup()的package_data中说明，data_files参数是
# 如果你的数据文件想被其他程序调用就把这些数据文件暴露出来。
#
# 打包的.py中的代码（包括__init__.py）如果想调用自身项目的其他模块的函数，一定是 import namespace.*
# ，即一定要在开头加命名域。
#
# 打包前一定要注意读写的数据文件一定是绝对路径，不能是相对路径，这个很重要！！！因为如果是相对路径，
# 数据文件会被编译器认为是位于调用cn_sort的包的程序所在的目录中，但实际并没有。
#
# pip install 你的包名 --update来检查你写的包时，为了省时间，切记不要再本地改完包内的程序后，再上传，再pip下载看
# 是否运行如自己所愿，而是直接在本地将安装好的自己写的包进行修改，不管系统怎么提示读写权限直接改完运行，不然上传下载看效果
# 很费时间。

with open("README.md", "r", encoding="utf-8") as f:
    long_description = f.read()

setup(
    name="cn_sort",
    version="0.8.0",
    license="MIT",
    description="按拼音和笔顺快速排序大量简体中文词组（支持百万数量级）。",
    long_description=long_description,
    long_description_content_type="text/markdown",
    author="bmxbmx3",
    author_email="982766639@qq.com",
    url="https://github.com/bmxbmx3/cn_sort/tree/master",
    download_url="https://pypi.org/project/cn-sort/#files",
    keywords=[
        "njupt chinese word sort pronounce bihua 排序 中文 拼音 笔画 笔顺 词 汉字",
    ],
    install_requires=[
        "pypinyin",
        "jieba"
    ],
    classifiers=[
        "Development Status :: 4 - Beta",
        "Intended Audience :: Developers",
        "Topic :: Software Development :: Build Tools",
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7"
    ],
    package_data={
        "": ["res/all_word.json", "res/logging.conf"]
    },
    packages=find_packages(include=["cn_sort", "readme_pic"], exclude=["modify_db"]),
    python_requires=">=3.6",
    project_urls={
        'Bug Reports': 'https://github.com/bmxbmx3/cn_sort/issues',
        'Source': 'https://github.com/bmxbmx3',
    },
)