From e52086cff168f53df640dd8a26102f5e6ae3bafa Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Thu, 20 May 2021 13:24:44 +0800 Subject: [PATCH 01/10] the README upgrade --- README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 84 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a90f8f8..c7bbf42 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,66 @@ Python DeMo - [一. 构建`venv`环境](#一-构建venv环境) - [1.1 venv2](#11-venv2) - [1.1.1 venv2 for mac](#111-venv2-for-mac) + - [1.1.1.1 venv2 16.7.5](#1111-venv2-1675) + - [1.1.1.2 venv2 20.4.6](#1112-venv2-2046) - [1.1.2 venv2 for windows](#112-venv2-for-windows) - [1.2 venv3](#12-venv3) - [1.2.1 venv3 for mac](#121-venv3-for-mac) + - [1.2.1.1 venv3 16.7.5](#1211-venv3-1675) + - [1.2.1.2 venv3 20.4.6](#1212-venv3-2046) - [1.2.2 venv3 for windows](#122-venv3-for-windows) - [二. 多模块配置](#二-多模块配置) +- [三. venvX activate](#三-venvx-activate) + - [3.1 activate for mac](#31-activate-for-mac) + - [3.2 activate for windows](#32-activate-for-windows) ## 一. 构建`venv`环境 +首先检查是否安装如下软件包: + +```bash +# python2 +python2 -m pip --version +python2 -m setuptools --version +python2 -m wheel --version +python2 -m virtualenv --version + + +# python3 +python3 -m pip --version +python3 -m setuptools --version +python3 -m wheel --version +python3 -m virtualenv --version +``` + +如果没有，请安装如下软件包: + +```bash +# python2 +python2 -m pip install setuptools wheel virtualenv +或 +python2 -m pip install virtualenv + +# python3 +python3 -m pip install setuptools wheel virtualenv +或 +python3 -m pip install virtualenv +``` + ### 1.1 venv2 #### 1.1.1 venv2 for mac +##### 1.1.1.1 venv2 16.7.5 + ```bash -virtualenv -p /usr/local/bin/python2 --no-site-packages venv2 +python2 -m virtualenv -p /usr/local/bin/python2 --no-site-packages venv2 +``` + +##### 1.1.1.2 venv2 20.4.6 + +```bash +python2 -m virtualenv -p /usr/local/bin/python2 venv2 ``` #### 1.1.2 venv2 for windows @@ -36,8 +82,16 @@ python2 -m virtualenv -p C:\Python\Python27\python2.exe venv2 > venv2.log #### 1.2.1 venv3 for mac +##### 1.2.1.1 venv3 16.7.5 + +```bash +python3 -m virtualenv -p /usr/local/bin/python3 --no-site-packages venv +``` + +##### 1.2.1.2 venv3 20.4.6 + ```bash -virtualenv -p /usr/local/bin/python3 --no-site-packages venv +python3 -m virtualenv -p /usr/local/bin/python3 venv ``` #### 1.2.2 venv3 for windows @@ -69,3 +123,31 @@ python3 -m virtualenv -p C:\Python\Python38\python3.exe venv > venv.log /Users/.../Python-DeMo/mock /Users/.../Python-DeMo/case ``` + +## 三. venvX activate + +### 3.1 activate for mac + +在控制台中输入如下命令，使得Mac 环境下的 `virtualenv` 生效: + +```bash +# python2 +source ./venv2/bin/activate + + +# python3 +source ./venv/bin/activate +``` + +### 3.2 activate for windows + +在控制台中输入如下命令，使得Windows 环境下的 `virtualenv` 生效: + +```bash +# python2 +source ./venv2/Scripts/activate + + +# python3 +source ./venv/Scripts/activate +``` From 53d8907af7e13ef77d9c685b28a474c536a0fa2f Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Thu, 20 May 2021 17:45:38 +0800 Subject: [PATCH 02/10] the python.languageServer upgrade --- .vscode/settings.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index a004a86..cdf23a3 100755 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -65,7 +65,8 @@ ], "python.pythonPath": "venv2/bin/python", "python.formatting.provider": "yapf", - "python.languageServer": "Microsoft", + "python.languageServer": "Jedi", + // "python.languageServer": "Microsoft", // "python.languageServer": "Pylance", "python.linting.pylintEnabled": false, "python.linting.flake8Enabled": true, From e1b6ff37032f331b74d2627d121aae4302449aa5 Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Thu, 20 May 2021 19:49:34 +0800 Subject: [PATCH 03/10] the README upgrade --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c7bbf42..95b774e 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,11 @@ Python DeMo - [1.2.1.2 venv3 20.4.6](#1212-venv3-2046) - [1.2.2 venv3 for windows](#122-venv3-for-windows) - [二. 多模块配置](#二-多模块配置) -- [三. venvX activate](#三-venvx-activate) - - [3.1 activate for mac](#31-activate-for-mac) - - [3.2 activate for windows](#32-activate-for-windows) +- [三. venvX activate and deactivate](#三-venvx-activate-and-deactivate) + - [3.1 venvX activate](#31-venvx-activate) + - [3.1.1 activate for mac](#311-activate-for-mac) + - [3.1.2 activate for windows](#312-activate-for-windows) + - [3.2 venvX deactivate](#32-venvx-deactivate) ## 一. 构建`venv`环境 @@ -124,9 +126,11 @@ python3 -m virtualenv -p C:\Python\Python38\python3.exe venv > venv.log /Users/.../Python-DeMo/case ``` -## 三. venvX activate +## 三. venvX activate and deactivate -### 3.1 activate for mac +### 3.1 venvX activate + +#### 3.1.1 activate for mac 在控制台中输入如下命令，使得Mac 环境下的 `virtualenv` 生效: @@ -139,15 +143,25 @@ source ./venv2/bin/activate source ./venv/bin/activate ``` -### 3.2 activate for windows +#### 3.1.2 activate for windows 在控制台中输入如下命令，使得Windows 环境下的 `virtualenv` 生效: ```bash # python2 -source ./venv2/Scripts/activate +./venv2/Scripts/activate # python3 -source ./venv/Scripts/activate +./venv/Scripts/activate ``` + +### 3.2 venvX deactivate + +如果要切换项目或以其他方式离开虚拟环境,只需运行: + +```bash +deactivate +``` + +如果要重新进入虚拟环境，请按照上述有关激活虚拟环境的相同说明进行操作,无需重新创建虚拟环境; From 118a56863373ccf7f0b8d11a4715d18384bf5b30 Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Wed, 26 May 2021 17:18:03 +0800 Subject: [PATCH 04/10] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20toml=E5=92=8C?= =?UTF-8?q?=E7=89=88=E6=9D=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- LICENSE.txt | 19 +++++++++++++++++++ MANIFEST.in | 10 ++++++++++ pyproject.toml | 17 +++++++++++++++++ 3 files changed, 46 insertions(+) create mode 100644 LICENSE.txt create mode 100644 MANIFEST.in create mode 100644 pyproject.toml diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..c74aced --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,19 @@ +Copyright (c) 2016 The Python Packaging Authority (PyPA) + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..ec8777d --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,10 @@ +# https://packaging.python.org/guides/using-manifest-in/ + +include pyproject.toml + +# Include the README +include *.md + +# Include the license file +include LICENSE.txt + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..8528d5a --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,17 @@ +[build-system] +# https://setuptools.readthedocs.io/en/latest/build_meta.html +# These are the assumed default build requirements from pip: +# https://pip.pypa.io/en/stable/cli/pip/#pep-517-and-518-support +# +# As of version 10.0, pip supports projects declaring dependencies that are +# required at install time using a pyproject.toml file, in the form described +# in PEP 518. When building a project, pip will install the required +# dependencies locally, and make them available to the build process. +# Furthermore, from version 19.0 onwards, pip supports projects specifying the +# build backend they use in pyproject.toml, in the form described in PEP 517. +# +requires = [ + "setuptools>=40.8.0", + "wheel" +] +build-backend = "setuptools.build_meta" From 9fdf91004802b18ff644993e8f229679feb6c53e Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Wed, 26 May 2021 17:18:21 +0800 Subject: [PATCH 05/10] the README upgrade --- README.md | 115 ++++++++++++++++++++++++++-- doc/description/directory/README.md | 3 + 2 files changed, 112 insertions(+), 6 deletions(-) create mode 100644 doc/description/directory/README.md diff --git a/README.md b/README.md index 95b774e..c450699 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # Python-DeMo Python DeMo @@ -19,7 +18,17 @@ Python DeMo - [3.1 venvX activate](#31-venvx-activate) - [3.1.1 activate for mac](#311-activate-for-mac) - [3.1.2 activate for windows](#312-activate-for-windows) - - [3.2 venvX deactivate](#32-venvx-deactivate) +- [四. 脚本](#四-脚本) + - [4.1 python version](#41-python-version) + - [4.2 pip setuptools wheel version](#42-pip-setuptools-wheel-version) + - [4.2.1 pip freeze list](#421-pip-freeze-list) + - [4.2.2 setuptools](#422-setuptools) + - [4.2.2.1 setup.cfg](#4221-setupcfg) + - [4.2.2.2 setup.py](#4222-setuppy) + - [4.3 virtualenv version](#43-virtualenv-version) + - [4.4 tox tox-travis version](#44-tox-tox-travis-version) + - [4.5 twine version](#45-twine-version) +- [五. 参考](#五-参考) ## 一. 构建`venv`环境 @@ -156,12 +165,106 @@ source ./venv/bin/activate ./venv/Scripts/activate ``` -### 3.2 venvX deactivate +## 四. 脚本 + +### 4.1 python version + +```bash +# python +python2 --version +# python help +python2 --help > ./Temp/help/python_help.txt +``` + +### 4.2 pip setuptools wheel version + +```bash +# pip +python2 -m pip --version + +# pip setuptools wheel help +python2 -m pip --help > ./Temp/help/python_pip_help.txt +## python2 -m setuptools --help > ./Temp/help/python_setuptools_help.txt +python2 -m setup.py --help-commands > ./Temp/help/python_setuptools_help.txt +python2 -m wheel --help > ./Temp/help/python_wheel_help.txt +``` + +#### 4.2.1 pip freeze list + +```bash +# pip freeze +python2 -m pip freeze > ./Temp/python_pip_freeze.txt +python2 -m pip list > ./Temp/python_pip_list.txt +``` + +#### 4.2.2 setuptools + +##### 4.2.2.1 setup.cfg + +```bash +# python2 build +python2 -m pip install build +python2 -m pip install --upgrade build +python2 -m build +python2 -m build > ./out/dist/build.txt + +# python3 build +python3 -m pip install build +python3 -m pip install --upgrade build +python3 -m build +python3 -m build > ./out/dist/build.txt +``` + +##### 4.2.2.2 setup.py + +```bash +# setup sdist +python2 setup.py sdist > ./out/dist/setup_sdist.txt +python3 setup.py sdist > ./out/dist/setup_sdist.txt + +python2 setup.py bdist_wheel --universal +python3 setup.py bdist_wheel --universal + +python2 setup.py bdist_wheel +python3 setup.py bdist_wheel +``` + +### 4.3 virtualenv version -如果要切换项目或以其他方式离开虚拟环境,只需运行: +```bash +# virtualenv +python2 -m virtualenv --version +# virtualenv help +python2 -m virtualenv --help > ./Temp/help/python_virtualenv_help.txt +``` + +### 4.4 tox tox-travis version ```bash -deactivate +# tox +python2 -m tox --version +# python2 -m tox-travis --version +# tox tox-travis help +python2 -m tox --help > ./Temp/help/python_tox_help.txt +# python2 -m tox-travis --help > ./Temp/help/python_tox_travis_help.txt ``` -如果要重新进入虚拟环境，请按照上述有关激活虚拟环境的相同说明进行操作,无需重新创建虚拟环境; +### 4.5 twine version + +```bash +# twine +python2 -m twine --version +# twine help +python2 -m twine --help > ./Temp/help/python_twine_help.txt + +# check python check and upload dist format +twine check dist/* +twine upload dist/* +``` + +## 五. 参考 + +1. https://packaging.python.org/tutorials/packaging-projects/ +2. https://packaging.python.org/guides/distributing-packages-using-setuptools/ +3. https://pypi.org/pypi?%3Aaction=list_classifiers +4. https://docs.python.org/2/distutils/setupscript.html#additional-meta-data diff --git a/doc/description/directory/README.md b/doc/description/directory/README.md new file mode 100644 index 0000000..7900cf0 --- /dev/null +++ b/doc/description/directory/README.md @@ -0,0 +1,3 @@ +# README + +this is dir modules. From 2842ac0d91a9ffb1784c3ad29a50da507ac13a34 Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Wed, 26 May 2021 17:18:32 +0800 Subject: [PATCH 06/10] the settings upgrade --- .vscode/settings.json | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index cdf23a3..f5f39d0 100755 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -65,12 +65,19 @@ ], "python.pythonPath": "venv2/bin/python", "python.formatting.provider": "yapf", + "python.formatting.yapfArgs": [ + "--style", "{based_on_style: pep8 ,indent_width: 4}", + "--ignore=E251", + ], "python.languageServer": "Jedi", // "python.languageServer": "Microsoft", // "python.languageServer": "Pylance", - "python.linting.pylintEnabled": false, + "python.linting.enabled": true, "python.linting.flake8Enabled": true, - "python.linting.flake8Args": ["--max-line-length=250"], + "python.linting.flake8Args": ["--max-line-length=250", "--verbose"], + "python.linting.ignorePatterns": [".vscode/*.py", "**/site-packages/**/*.py"], + "python.linting.lintOnSave": true, + "python.linting.pylintEnabled": false, "python.testing.unittestArgs": [ "-v", "-s", From c45bfffab997f0b480a7369a94b5053defa26456 Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Wed, 26 May 2021 18:25:09 +0800 Subject: [PATCH 07/10] the settings upgrade --- .vscode/settings.json | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index f5f39d0..4d6507c 100755 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -66,15 +66,18 @@ "python.pythonPath": "venv2/bin/python", "python.formatting.provider": "yapf", "python.formatting.yapfArgs": [ - "--style", "{based_on_style: pep8 ,indent_width: 4}", - "--ignore=E251", + "--style", "{based_on_style: pep8 ,indent_width: 4, column_limit: 130}", ], "python.languageServer": "Jedi", // "python.languageServer": "Microsoft", // "python.languageServer": "Pylance", "python.linting.enabled": true, "python.linting.flake8Enabled": true, - "python.linting.flake8Args": ["--max-line-length=250", "--verbose"], + "python.linting.flake8Args": [ + "--max-line-length=250", + "--ignore=E251", + "--verbose", + ], "python.linting.ignorePatterns": [".vscode/*.py", "**/site-packages/**/*.py"], "python.linting.lintOnSave": true, "python.linting.pylintEnabled": false, From f4b779261c6e2d6ad0e38a7acb7406c2e068d5fa Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Thu, 27 May 2021 14:49:29 +0800 Subject: [PATCH 08/10] to add tox --- README.md | 2 +- tox.ini | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 tox.ini diff --git a/README.md b/README.md index c450699..1b22dd2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Python-DeMo -Python DeMo +![Python Logo](https://www.python.org/static/community_logos/python-logo.png "Python DeMo") - [一. 构建`venv`环境](#一-构建venv环境) - [1.1 venv2](#11-venv2) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..f594360 --- /dev/null +++ b/tox.ini @@ -0,0 +1,35 @@ +# tox (https://tox.readthedocs.io/) is a tool for running tests +# in multiple virtualenvs. This configuration file will run the +# test suite on all supported python versions. To use it, "pip install tox" +# and then run "tox" from this directory. +# For information see https://tox.readthedocs.io/en/latest/examples.html + +[tox] +envlist = py27, py39 + +minversion = 3.23.1 + +# Activate isolated build environment. tox will use a virtual environment +# to build a source distribution from the source tree. For build tools and +# arguments use the pyproject.toml file as specified in PEP-517 and PEP-518. +isolated_build = true + +# install testing framework +# ... or install anything else you might need here +[testenv] +platform = linux: linux + macos: darwin + windows: win32 +; alwayscopy = True +allowlist_externals = + /bin/bash +changedir = + tests +deps = + build + discover +commands = + ; windows: python --version + ; macos,linux: python --version + discover + ; python -m unittest discover From 985d7387963833feea08df8437a7dcbe61375865 Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Thu, 27 May 2021 18:47:29 +0800 Subject: [PATCH 09/10] the README upgrade --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 1b22dd2..1be1e50 100644 --- a/README.md +++ b/README.md @@ -249,6 +249,18 @@ python2 -m tox --help > ./Temp/help/python_tox_help.txt # python2 -m tox-travis --help > ./Temp/help/python_tox_travis_help.txt ``` +如若快捷生成脚本,参考如下命令: + +```bash +tox-quickstart +``` + +默认运行命令，如下: + +```bash +tox +``` + ### 4.5 twine version ```bash From 56e7977ec2e77d98087fb4e00cde104aa04e7e8b Mon Sep 17 00:00:00 2001 From: zhenwei-li Date: Fri, 28 May 2021 15:52:39 +0800 Subject: [PATCH 10/10] =?UTF-8?q?=E6=9E=84=E5=BB=BA=E4=B8=8E=E5=88=86?= =?UTF-8?q?=E5=8F=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 330 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 328 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1be1e50..831cf88 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,22 @@ - [4.3 virtualenv version](#43-virtualenv-version) - [4.4 tox tox-travis version](#44-tox-tox-travis-version) - [4.5 twine version](#45-twine-version) -- [五. 参考](#五-参考) +- [五. 构建与分发](#五-构建与分发) + - [5.1 安装](#51-安装) + - [5.2 配置](#52-配置) + - [5.2.1 pyproject.toml](#521-pyprojecttoml) + - [5.2.2 MANIFEST.in](#522-manifestin) + - [5.2.3 tox.ini](#523-toxini) + - [5.2.4 setup.cfg](#524-setupcfg) + - [5.2.5 README.md](#525-readmemd) + - [5.3 构建](#53-构建) + - [5.3.1 tox 脚本测试](#531-tox-脚本测试) + - [5.3.2 build](#532-build) + - [5.3 发布](#53-发布) + - [5.3.1 注册账号](#531-注册账号) + - [5.3.2 检查软件包](#532-检查软件包) + - [5.3.3 上传软件包](#533-上传软件包) +- [六. 参考](#六-参考) ## 一. 构建`venv`环境 @@ -274,7 +289,318 @@ twine check dist/* twine upload dist/* ``` -## 五. 参考 +## 五. 构建与分发 + +Python 软件包开发工程结构，如下所示: + +```Django +# soft package tree + +--- project root + | + | --- .tox + | --- .vscode + | --- build + | --- dist + | --- doc + --- ... + --- README.md + | --- src + --- com + --- dvsnier + --- ... + | --- test + --- com + --- dvsnier + --- ... + | --- venv + | --- venv2 + | --- .editorconfig + | --- .gitignore + | --- LICENSE.txt + | --- MANIFEST.in + | --- pyproject.toml + | --- README.md + | --- setup.cfg + | --- tox.ini +``` + +### 5.1 安装 + +首先检查是否安装如下依赖: + +1. pip +2. flake8 (可选) +3. virtualenv +4. setuptools +5. wheel +6. discover +7. tox +8. toml (可选) +9. tox-travis (可选) +10. build +11. twine + +如若没有，请使用`pip` 命令安装如下软件包: + +```bash +# python2 pip version +python2 -m pip --version + +python2 -m pip install flake8 +python2 -m pip install virtualenv +python2 -m pip install setuptools +python2 -m pip install wheel +python2 -m pip install discover +python2 -m pip install tox +python2 -m pip install toml +python2 -m pip install tox-travis +python2 -m pip install build +python2 -m pip install twine + +# python3 pip version +python3 -m pip --version + +python3 -m pip install flake8 +python3 -m pip install virtualenv +python3 -m pip install setuptools +python3 -m pip install wheel +python3 -m pip install discover +python3 -m pip install tox +python3 -m pip install toml +python3 -m pip install tox-travis +python3 -m pip install build +python3 -m pip install twine +``` + +其实一般安装有 `pip` 软件包的，一般都会有`setuptools` 和`wheel` 软件包附带安装; + +### 5.2 配置 + +#### 5.2.1 pyproject.toml + +首先配置 `pyproject.toml` ，模板固定, 一般不需大范围改动; + +```bash +[build-system] +# https://setuptools.readthedocs.io/en/latest/build_meta.html +# These are the assumed default build requirements from pip: +# https://pip.pypa.io/en/stable/cli/pip/#pep-517-and-518-support +# +# As of version 10.0, pip supports projects declaring dependencies that are +# required at install time using a pyproject.toml file, in the form described +# in PEP 518. When building a project, pip will install the required +# dependencies locally, and make them available to the build process. +# Furthermore, from version 19.0 onwards, pip supports projects specifying the +# build backend they use in pyproject.toml, in the form described in PEP 517. +# +requires = [ + "setuptools>=40.8.0", + "wheel" +] +build-backend = "setuptools.build_meta" +``` + +#### 5.2.2 MANIFEST.in + +然后配置 `MANIFEST.in` 软件包应当包含哪些信息,哪些排除配置信息, 如下所示: + +```bash +# https://packaging.python.org/guides/using-manifest-in/ + +include pyproject.toml + +# Include the README +include *.md + +# Include the license file +include LICENSE.txt +``` + +同上，模板一般都是固定结构，无需太范围改动; + +#### 5.2.3 tox.ini + +再然后配置 `tox` 脚本自动化测试, 指定Python 虚拟环境版本, 配置信息如下: + +```bash +# tox (https://tox.readthedocs.io/) is a tool for running tests +# in multiple virtualenvs. This configuration file will run the +# test suite on all supported python versions. To use it, "pip install tox" +# and then run "tox" from this directory. +# For information see https://tox.readthedocs.io/en/latest/examples.html + +[tox] +envlist = py27, py39 + +minversion = 3.23.1 + +# Activate isolated build environment. tox will use a virtual environment +# to build a source distribution from the source tree. For build tools and +# arguments use the pyproject.toml file as specified in PEP-517 and PEP-518. +isolated_build = true + +# install testing framework +# ... or install anything else you might need here +[testenv] +platform = linux: linux + macos: darwin + windows: win32 +; alwayscopy = True +allowlist_externals = + /bin/bash +changedir = + tests +deps = + build + discover + twine +commands = + discover + ; python -m unittest discover +``` + +#### 5.2.4 setup.cfg + +最后配置 `setup.cfg` 构建脚本, 指定软件包所要构建的软件细节部分, 举例配置信息如下: + +```bash +[metadata] +# 1. https://setuptools.readthedocs.io/en/latest/ +# 2. https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html +# 3. https://setuptools.readthedocs.io/en/latest/references/keywords.html +name = com.dvsnier.directory +version = 0.0.1.dev1 +author = dvsnier +author_email = dovsnier@qq.com +description = this is dvsnier directory. +long_description = file: ./doc/description/directory/README.md +long_description_content_type = text/markdown +keywords = dir, development +url = https://github.com/Alinvor/Python-DeMo +project_urls = + Documentation = https://packaging.python.org/tutorials/distributing-packages/ + Funding = https://donate.pypi.org + Wiki = https://github.com/Alinvor/Python-DeMo/wiki + Bug_Tracker = https://github.com/Alinvor/Python-DeMo/issues + Source = https://github.com/Alinvor/Python-DeM +platforms = any +# classifiers +# Development Status :: 3 - Alpha +# Development Status :: 4 - Beta +# Development Status :: 5 - Production/Stable +classifiers = + Development Status :: 3 - Alpha + Programming Language :: Python :: 2.7 + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + License :: OSI Approved :: MIT License + Operating System :: OS Independent + +python_requires = + >=2.7 + <4 + +# This includes the license file(s) in the wheel. +# https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file +# https://choosealicense.com/ +license = MIT License +license_files = + LICENSE.txt + +[options] +package_dir = + = src + +packages = find: + +[options.packages.find] +where = src +# +# https://packaging.python.org/guides/distributing-packages-using-setuptools/#wheels +# +[bdist_wheel] +universal = 1 +``` + +> 软件包`名称`和软件包`版本`信息, 一定要明确具体发布规则; + +实际项目中, 可依据如上配置信息稍加修改和增添; + +#### 5.2.5 README.md + +更新`README.md` 版本和摘要信息; + +### 5.3 构建 + +#### 5.3.1 tox 脚本测试 + +首次运行`tox` 命令，可使用`tox-quickstart` 命令, 依据简短提示信息进行配置: + +```bash +tox-quickstart +``` + +后续运行`tox` 命令，可执行自动化脚本测试: + +```bash +tox +``` + +#### 5.3.2 build + +可使用如下命令, 进行`xxx.tar.gz` 源码包和`xxx.whl` 二进制包构建, 命令如下: + +```bash +# python build tar.gz and whl +python2 -m build + +# python build tar.gz +python2 -m build --sdist +# python build whl +python2 -m build --wheel + + +# python build tar.gz and whl +python3 -m build + +# python build tar.gz +python3 -m build --sdist +# python build whl +python3 -m build --wheel +``` + +### 5.3 发布 + +#### 5.3.1 注册账号 + +1. 账户注册地址: https://pypi.org/account/register/ +2. 创建一个[PyPI API令牌](https://pypi.org/help/#apitoken), 以便能够安全地上传您的项目; +3. 为了避免每次上载时都必须复制和粘贴令牌，可以创建一个`$HOME/.pypirc` 文件, 参考如下: + +```bash +[pypi] +username = __token__ +password = +``` + +#### 5.3.2 检查软件包 + +检查软件包, 命令: + +```bash +twine check dist/* +``` + +#### 5.3.3 上传软件包 + +上传软件包, 命令: + +```bash +twine upload dist/* +``` + +## 六. 参考 1. https://packaging.python.org/tutorials/packaging-projects/ 2. https://packaging.python.org/guides/distributing-packages-using-setuptools/