Python 的 pip install 大家都很熟悉吧~
但是我们今天要来讲讲,如何自己使用 OOP 面向对象编程来写一个 Package,然后上传到 Pypy,让别人可以 pip install。
如何写一个符合安装的 Package
Python 模块只是一个包含代码的 Python 文件,可以在别的代码块中被引用。
但是 Package 是可以安装的模块的集合,Python包需要一个__init__.py文件。
1. 文件结构
package 结构这里可以看到可以被用于安装的文件夹里面有一个 distributions 的文件夹,这个名字也是 package 的名字,此外也有一个 setup.py 的文件
先来看一个 setup.py 文件,是 Package 的属性。
from setuptools import setup
setup(name='distributions',
version='0.1',
description='Gaussian distributions',
packages=['distributions'],
zip_safe=False)
接下来,就是 文件夹里面的 distribution 文件夹的结构。
结构每个 Package 都需要一个 __init__.py 的文件去处理初始化问题,下面来看一下里面书写的内容。
from .Gaussiandistribution import Gaussian
尽管不书写,整个 Package 安装也是没有问题的,但是在使用的时候,会是的引用变得繁琐。通过结构可以看到,我们的 Class 类是在 Caussiandistribution.py 里面的,因此当初始化使用了这句代码,我们就可以直接引用类了,即,from distributions import Gaussian 就可以直接使用了。
README.md 就是对于 package 功能的说明。
license.txt 是一个使用规范,我们通常会直接 copy MIT 的说明,如下。
Copyright <YEAR> <COPYRIGHT HOLDER>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.
setup.cfg 是一个默认文档,表明需要显示的内容。以下就是文档内的内容。
[metadata]
description-file = README.md
2. 上传 Pypi
# 在 Terminal 中进入相应的文件
cd binomial_package_files
# 生成需要上传的配套文件,egg、zip 等
python setup.py sdist
# 安装上传所有的工具 twine
pip install twine
# 上传到 pypi 的测试路径
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# 测试安装效果
pip install --index-url https://test.pypi.org/simple/ distribution
# 测试没有问题后上传到正式路径
twine upload dist/* pip install distribution
网友评论