IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> Python知识库 -> 如何在 pypi 上发布自己的 python 包 -> 正文阅读

[Python知识库]如何在 pypi 上发布自己的 python 包

为什么人们喜欢视频学习?一篇文章中解释到,人类学习效率最高的方式,不是"读书 + 思考",而是"观察 + 模仿"。 前者需要较长时间的注意力投入,后者只需要短时间注意力,更符合人类的天性。
呼伦贝尔-186彩带河

准备工作

  • 首先在 pipy 上注册自己的帐号,这一步不再赘述
  • 本地电脑上安装有 python 的环境,这里推荐 3.x 以上的 python 环境
  • 打包工作主要依赖 python 的一个叫 setuptools 的包来完成,因此安装这个包 pip install setuptools

组织代码结构

下面是我所发布的包的一个初始结构,这个项目是为公司写的,名字为 orbitkit

orbitkit(也可以用 abc 来命名)
  ├── docs
  ├── examples
  ├─┬ orbitkit
  │ ├── file-extractor
  │ ├── util
  │ └── __init__.py
  ├── .gitignore
  ├── LICENSE
  ├── README.md
  └── setup.py

在这里我们的项目名字是 orbitkit,在 orbitkit 项目的根目录下有一个重名的文件夹。这里要注意,项目名字取什么其实不重要,如果你喜欢也可以用 abc 来命名,重要的是和 setup.py 同级的根目录下的 orbitkit 文件夹一定要是我们要发布的名字。

docsexamples 这两个文件夹顾名思义,一个是项目的文档,另一个是使用实例,能让用户更好的了解我们的项目。

LICENSE 是我们项目的许可证书,这里不做详细讨论。

这里重点讨论 orbitkit 文件夹,也就是我们的核心代码文件夹。python 和 java 不一样,并不是一个文件就是一个类,在 python 中一个文件中可以写多个类。我们推荐把希望向用户暴漏的类和方法都先导入到 __init__.py 中,并且用关键词 __all__ 进行限定。下面是我的一个 __init__.py 文件。

from orbitkit import util
from orbitkit.file_extractor.dispatcher import FileDispatcher

name = 'orbitkit'

__version__ = '0.0.8'
VERSION = __version__

__all__ = [
    'util',
    'FileDispatcher',
]

这样用户在使用的时候可以清楚的知道哪些类和方法是可以使用的,也就是关键词 __all__ 所限定的类和方法。

另外,在写自己代码库的时候,即便我们可以使用相对导入,但是模块导入一定要从项目的根目录进行导入,这样可以避免一些在导入包的时候因路径不对而产生的问题。比如

from orbitkit.file_extractor.dispatcher import FileDispatcher

我就是是从 orbitkit 开始导入的。

准备 setup.py 文件

setup.py 是进行文件打包发布的配置文件,包括要发布的包名字,版本,license,描述,特性(classifier) 等等。必须要将其放到项目的根目录下,下面是我再为公司的写的一个包的 setup.py 配置文件。

from setuptools import setup, find_packages
import orbitkit

setup(
    name='orbitkit',
    version=orbitkit.__version__,
    description=(
        'This project is only for Orbit Tech internal use.'
    ),
    long_description=open('README.md', 'r', encoding='utf-8').read(),
    long_description_content_type="text/markdown",
    author='Lilu Cao',
    author_email='lilu.cao@qq.com',
    maintainer='Lilu Cao',
    maintainer_email='lilu.cao@qq.com',
    license='MIT License',
    packages=find_packages(),
    platforms=["all"],
    url='https://github.com/clown-0726/orbitkit',
    classifiers=[
        # 'Development Status :: 4 - Beta',
        'Operating System :: OS Independent',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: BSD License',
        'Programming Language :: Python',
        'Programming Language :: Python :: Implementation',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Topic :: Software Development :: Libraries'
    ],
    install_requires=[
        "boto3 >= 1.17.0",
        "requests >= 2.12.1",
    ]
)

在上一个段落中我们看到我们程序的版本号定义了 __init__.py 文件中,因此在 setup.py 文件中我们就直接导入就好了。

准备 README.md 文件

一个好的 README.md 文件能让用户更好的了解我们的项目,并且快速上手使用。

README.md 文件会出现在两个地方,一个地方是自己的 github 仓库中介绍中,另一个是 pipy 的项目介绍中。现在很多优秀的代码库的 README.md 文件都写的非常好,这里推荐仿照成熟库的 README.md 文件来写自己的。

打包代码

可以使用下面命令打包一个源代码的包:

python setup.py sdist build

上传到 pipy

可以使用 setuptools,或者 twine 上传,推荐使用 twine 上次,因为使用 setuptools 上传时,你的用户名和密码是明文或者未加密传输,安全起见还是使用twine。

sudo pip install twine

twine upload dist/*

会提示你输入帐号和密码,输入完后上传即可.

TODO

这里只是讨论来如何创建一个自己的 pipy 包,并没有提及测试项目,之后会补充如何使用 tox 进行测试。

Reference

[1] 在Pypi上发布自己的Python包: https://www.cnblogs.com/sting2me/p/6550897.html
[2] django-rest-framework: https://github.com/encode/django-rest-framework

  Python知识库 最新文章
Python中String模块
【Python】 14-CVS文件操作
python的panda库读写文件
使用Nordic的nrf52840实现蓝牙DFU过程
【Python学习记录】numpy数组用法整理
Python学习笔记
python字符串和列表
python如何从txt文件中解析出有效的数据
Python编程从入门到实践自学/3.1-3.2
python变量
上一篇文章      下一篇文章      查看所有文章
加:2021-07-29 11:35:59  更:2021-07-29 11:37:06 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年12日历 -2024/12/25 14:24:55-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码
数据统计