setup.py的官方說明文檔
- distutils安裝腳本編寫說明
打開上面的鏈接之后，你可以選擇Python的版本、以及文檔的語言。 - setuptools安裝腳本編寫說明 [推薦使用]
建議查看下面兩篇博客查看具體案例：
- python項目打包（二）------ 利用setup.py打包項目 https://www.cnblogs.com/dan-baishucaizi/p/14340712.html
- python項目打包（三）------ 利用cx_Freeze打包項目為含環境的應用
setuptools安裝腳本官方教程解讀
打包和分發的需求
首先你的有Python環境(這不是廢話嘛)，環境的具體要求如下：
- 命令行python可執行，可以使用 python --version 測試
- 命令行pip是可執行命令，可以使用 pip --version 測試
如果顯示沒有安裝，就使用引導：python -m ensurepip --default-pip - 確保你的pip、setuptools、wheel是最新的
使用命令：python -m pip install --upgrade pip setuptools wheel進行更新
如果你要上傳你的包到PYPI，那么你得下載twine這個包
shell pip install twine
配置你的項目
當開始關注setup.py時，requirements.txt自不必多說，這里的requirements.txt文件、your package下的目錄結構是我添加的，非官方示例，你可以自由選擇。上面的項目示意圖是我建議的源代碼目錄結構
setup.py
首先得有setup.py，且此文件需要放置在項目的根目錄下。下面是Python的示例項目：
看到這，我們應該知道這個文件是干嘛的，不然你咋看到這的，迷路了嗎？當年寫好這個文件后，我們可以使用下面的命令查看哪些參數我們可以使用。
這個結果和具體項目有關，不同的setup.py文件結果不一樣！
setup.cfg文件
setup.cfg主要記錄setup.py的一些默認選項。
EasyOCR這個項目里面的setup.cfg配置信息如下：
[metadata]
description-file = README.md
更多信息，等待更新……
README文檔
所有項目都應該包含一個包含項目目標的自述文件。最常見的是使用restructedText(rst格式)，當然這不是必須的，目前很多項目都使用Markdown文檔，至少在GitHub上面，我的使用范圍內這更常見！
MANIFEST.in文檔
MANIFEST.in文件是被需要的，當你要打包沒有包含在發行源里的文件時，需要將這些路徑羅列出來。同樣以EasyOCR為例，它的MANIFEST.in文件內容為：
include LICENSE.txt
include README.md
include easyocr/model/*
include easyocr/character/*
include easyocr/dict/*
LICENSE.txt文件
每個軟件包都應該包含一個許可證文件，詳細說明分發條款。在許多司法管轄區，沒有明確許可證的軟件包不能由版權所有者以外的任何人合法使用或分發。我知道你的項目都不想給我們使用，不過萬一你突然想開源一個項目呢？在GitHub中會經常看見Apache、GPL、MIT等協議，這些協議對應的不同的權限，不知道怎么寫這部分，可以參考Choose an open source license。
你的項目文件
這個文件夾是個性化的，不同的項目有不同的名字及結構，但是對於同一個公司或者個人，你的項目最好采用統一的源代碼結構規范，無規矩不成方圓。
setup.py內部函數setup介紹
setup.py文件包含了一個全局的setup函數，看具體參數之前我們先看看官方示例與EasyOCR的setup.py文件
官方示例
```python
"""A setuptools based setup module.
See:
https://packaging.python.org/guides/distributing-packages-using-setuptools/
https://github.com/pypa/sampleproject
"""
# Always prefer setuptools over distutils
from setuptools import setup, find_packages
import pathlib
here = pathlib.Path(__file__).parent.resolve()
# Get the long description from the README file
long_description = (here / 'README.md').read_text(encoding='utf-8')
# Arguments marked as "Required" below must be included for upload to PyPI.
# Fields marked as "Optional" may be commented out.
setup(
# This is the name of your project. The first time you publish this
# package, this name will be registered for you. It will determine how
# users can install this project, e.g.:
#
# $ pip install sampleproject
#
# And where it will live on PyPI: https://pypi.org/project/sampleproject/
#
# There are some restrictions on what makes a valid project name
# specification here:
# https://packaging.python.org/specifications/core-metadata/#name
name='sampleproject', # Required
# Versions should comply with PEP 440:
# https://www.python.org/dev/peps/pep-0440/
#
# For a discussion on single-sourcing the version across setup.py and the
# project code, see
# https://packaging.python.org/en/latest/single_source_version.html
version='2.0.0', # Required
# This is a one-line description or tagline of what your project does. This
# corresponds to the "Summary" metadata field:
# https://packaging.python.org/specifications/core-metadata/#summary
description='A sample Python project', # Optional
# This is an optional longer description of your project that represents
# the body of text which users will see when they visit PyPI.
#
# Often, this is the same as your README, so you can just read it in from
# that file directly (as we have already done above)
#
# This field corresponds to the "Description" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-optional
long_description=long_description, # Optional
# Denotes that our long_description is in Markdown; valid values are
# text/plain, text/x-rst, and text/markdown
#
# Optional if long_description is written in reStructuredText (rst) but
# required for plain-text or Markdown; if unspecified, "applications should
# attempt to render [the long_description] as text/x-rst; charset=UTF-8 and
# fall back to text/plain if it is not valid rst" (see link below)
#
# This field corresponds to the "Description-Content-Type" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
long_description_content_type='text/markdown', # Optional (see note above)
# This should be a valid link to your project's main homepage.
#
# This field corresponds to the "Home-Page" metadata field:
# https://packaging.python.org/specifications/core-metadata/#home-page-optional
url='https://github.com/pypa/sampleproject', # Optional
# This should be your name or the name of the organization which owns the
# project.
author='A. Random Developer', # Optional
# This should be a valid email address corresponding to the author listed
# above.
author_email='author@example.com', # Optional
# Classifiers help users find your project by categorizing it.
#
# For a list of valid classifiers, see https://pypi.org/classifiers/
classifiers=[ # Optional
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 3 - Alpha',
# Indicate who your project is intended for
'Intended Audience :: Developers',
'Topic :: Software Development :: Build Tools',
# Pick your license as you wish
'License :: OSI Approved :: MIT License',
# Specify the Python versions you support here. In particular, ensure
# that you indicate you support Python 3. These classifiers are *not*
# checked by 'pip install'. See instead 'python_requires' below.
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3 :: Only',
],
# This field adds keywords for your project which will appear on the
# project page. What does your project relate to?
#
# Note that this is a list of additional keywords, separated
# by commas, to be used to assist searching for the distribution in a
# larger catalog.
keywords='sample, setuptools, development', # Optional
# When your source code is in a subdirectory under the project root, e.g.
# `src/`, it is necessary to specify the `package_dir` argument.
package_dir={'': 'src'}, # Optional
# You can just specify package directories manually here if your project is
# simple. Or you can use find_packages().
#
# Alternatively, if you just want to distribute a single Python file, use
# the `py_modules` argument instead as follows, which will expect a file
# called `my_module.py` to exist:
#
# py_modules=["my_module"],
#
packages=find_packages(where='src'), # Required
# Specify which Python versions you support. In contrast to the
# 'Programming Language' classifiers above, 'pip install' will check this
# and refuse to install the project if the version does not match. See
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
python_requires='>=3.5, <4',
# This field lists other packages that your project depends on to run.
# Any package you put here will be installed by pip when your project is
# installed, so they must be valid existing projects.
#
# For an analysis of "install_requires" vs pip's requirements files see:
# https://packaging.python.org/en/latest/requirements.html
install_requires=['peppercorn'], # Optional
# List additional groups of dependencies here (e.g. development
# dependencies). Users will be able to install these using the "extras"
# syntax, for example:
#
# $ pip install sampleproject[dev]
#
# Similar to `install_requires` above, these must be valid existing
# projects.
extras_require={ # Optional
'dev': ['check-manifest'],
'test': ['coverage'],
},
# If there are data files included in your packages that need to be
# installed, specify them here.
package_data={ # Optional
'sample': ['package_data.dat'],
},
# Although 'package_data' is the preferred approach, in some case you may
# need to place data files outside of your packages. See:
# http://docs.python.org/distutils/setupscript.html#installing-additional-files
#
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
data_files=[('my_data', ['data/data_file'])], # Optional
# To provide executable scripts, use entry points in preference to the
# "scripts" keyword. Entry points provide cross-platform support and allow
# `pip` to create the appropriate form of executable for the target
# platform.
#
# For example, the following would provide a command called `sample` which
# executes the function `main` from this package when invoked:
entry_points={ # Optional
'console_scripts': [
'sample=sample:main',
],
},
# List additional URLs that are relevant to your project as a dict.
#
# This field corresponds to the "Project-URL" metadata fields:
# https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
#
# Examples listed include a pattern for specifying where the package tracks
# issues, where the source is hosted, where to say thanks to the package
# maintainers, and where to support the project financially. The key is
# what's used to render the link text on PyPI.
project_urls={ # Optional
'Bug Reports': 'https://github.com/pypa/sampleproject/issues',
'Funding': 'https://donate.pypi.org',
'Say Thanks!': 'http://saythanks.io/to/example',
'Source': 'https://github.com/pypa/sampleproject/',
},
)
```
EasyOCR示例
```python
"""
End-to-End Multi-Lingual Optical Character Recognition (OCR) Solution
"""
from setuptools import setup
from io import open
with open('requirements.txt', encoding="utf-8-sig") as f:
requirements = f.readlines()
def readme():
with open('README.md', encoding="utf-8-sig") as f:
README = f.read()
return README
setup(
name='easyocr',
packages=['easyocr'],
include_package_data=True,
version='1.1.7',
install_requires=requirements,
entry_points={"console_scripts": ["easyocr= easyocr.cli:main"]},
license='Apache License 2.0',
description='End-to-End Multi-Lingual Optical Character Recognition (OCR) Solution',
long_description=readme(),
long_description_content_type="text/markdown",
author='Rakpong Kittinaradorn',
author_email='r.kittinaradorn@gmail.com',
url='https://github.com/jaidedai/easyocr',
download_url='https://github.com/jaidedai/easyocr.git',
keywords=['ocr optical character recognition deep learning neural network'],
classifiers=[
'Development Status :: 5 - Production/Stable'
],
)
```
上面我們初步認識了setup.py文件，下面重點看一下setup函數。
參數name
此參數是你的項目名字，項目命名簡潔一些，不要花里胡哨，分割符“-”、“_”、“.”等用一個就好，多了它也認為是一個冗余，搜索時相似的結構都會指向同一對象。
參數version
指定項目的版本號，如：version='1.2.0'，
參數description
項目的詳細描述
description='A sample Python project',
long_description=long_description,
long_description_content_type='text/x-rst',
參數url
你的項目主頁