构建自己的Python开源包

要融入社区,第一步当然是要撰写一个自己的包。整个过程主要分为五步:

  • 项目创建
  • 搭建虚拟运行环境
  • 编写项目代码
  • 编写安装脚本
  • 上传PyPi

GIT 创建项目

创建项目,确定项目名称,description, license等:

项目地址:https://github.com/shikanon/BaiduMapAPI

搭建虚拟环境

我们在搭建自己的库的时候,是希望有一个干净的项目环境的,这时候virtualenv就很有用了,采用 virtualev 搭建虚拟环境,可以方便为后面生成私有项目的 requirement.txt 依赖包文件。

创建虚拟环境

virtualev venv

启用 virtualev :

source venv/Script/activate

构建项目代码

简单,快速构建框架原型和骨架,记得包之间需要 __init__.py 文件,后面在编写setup.py也会很有用。 项目结构:

构建好架构后,可以开始编写单元测试代码,pytest是个简单易用的库,可以帮助我们快速完成单元测试构建。

构建安装脚本,编写 setup.py 文件

完成代码构建和测试就可以开始进入构建安装包环节。 Python三方库安装常用的主要有两种模式:一种是直接从 github 上 clone 下来用 setup.py 安装,另一种是用 pip install 来安装。两种安装方法都是需要编写 setup.py 文件的。

对于第一种方法我们在安装前一般还要提供安装的依赖包, 也就是requirement.txt文件。在这里我们可以直接用 pip freeze 命令生成:

pip freeze > requirement.txt

因为我们是采用新建的虚拟环境开发,所以可以直接把环境中的三方库导入到requirement.txt 文件中。

构建好 requirement.txt后,就可以编写安装脚本。 这里采用了setuptools编写安装脚本,Setuptools是一个包开发过程库,其增强Python标准库distutils,使得打包Python项目更简单。

setup.py文件案例:

from setuptools import Command, find_packages, setup

__lib_name__ = "BaiduMapAPI"
__lib_version__ = "0.1.1"
__description__ = "The Package of Baidu Map, with unofficial"
__url__ = "https://github.com/shikanon/BaiduMapAPI"
__author__ = "shikanon"
__author_email__ = "account@shikanon.com"
__license__ = "MIT"
__keywords__ = ["Baidu", "map"]
__requires__ = ["requests",]

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

setup(
    name = __lib_name__,
    version = __lib_version__,
    description = __description__,
    url = __url__,
    author = __author__,
    author_email = __author_email__,
    license = __license__,
    packages = find_packages(exclude=("tests", "exmaple")),
    install_requires = __requires__,
    zip_safe = False,
    include_package_data = True,
    data_files = [("BaiduMapAPI/data", ["BaiduMapAPI/data/BaiduMap_cityCode_1102.txt"])],
    long_description = __long_description__
)

name 包名称 version 版本号 description 包描述 url 包地址 license 授权信息 packages 需要处理的包目录,也就是包含__init__.py的文件夹 install_requires 需要安装的依赖包 data_files 可以用于引入一些额外的信息文件和数据,如图片、配置文件, [('文件要放入的文件夹1',['file1',file2']),('文件要放入的文件夹2',['file3',file4'])] 第一个元素指最后在文件要放的位置/目录,如果空字符,表示放在根目录,第二个元素指原文件所在的位置。 long_description 包的详细描述,后续上传到pypi,可以用于显示在主页上的描述

find_packages():这个函数会默认在和setup.py同一目录下搜索各个含有init.py的包。 除了通过data_files添加数据包文件,还可以通过package_data设置可以被find_packages找到添加的文件:

packages = find_packages(exclude=("tests", "exmaple")),  # 所有包除了tests和exmaple
package_data = {
    '': ['*.csv'], # 任何包中含有.csv文件,都包含它
    'data': ['data/*.dat'], # 包含data包data文件夹中的 *.dat文件
}

写好setup.py文件,可以python setupy install进行安装测试。

注册 pypi 并上传自己的库

编写好安装脚本,就可以上传PyPi,当然,上传前要先看看上面是否已经有编写好的相关库了。 如果很幸运没有,那么可以开始上传自己的包了,这里我们采用twine协助上传。

  • 首先,完成PyPi的账户注册。
  • 在用户目录下创建.pypirc文件, Linux在$HOME创建.pypirc, Windows在%HOMEDRIVE%下创建.pypirc,加入: [distutils] index-servers = pypi pypitest [pypi] repository: https://upload.pypi.org/legacy/ username: 账户 password: 密码 [pypitest] repository: https://test.pypi.org/legacy/ username: 账户 password: 密码
  • 安装twine: pip install twine
  • 创建: python setup.py sdist bdist_wheel
  • 上传PyPi: twine upload dist/*

上传成功后可以运行pip install命令测试。

编写文档

编写README.md和说明文档docs,这里我们用sphinx库来创建文档架构,sphinx是一个智能、漂亮的文档生成工具。

初始化docs文件夹

sphinx-quickstart

编写rst文件,运行make html即可生成html文档,

rst文档例子:

Welcome to BaiduMapAPI's documentation!
=======================================

.. toctree::
   :caption: Basic concepts
   :hidden:

   api
   dataset


   Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

注: 如果已经有配置文件了,可以用sphinx-build来指定生成目录 sphinx-build -b html source/ build/

上传github

最后上传到 github,这样一个完整的 Python 三方包的开源完成了。


Windows上得中文Python二进制包资源: https://www.lfd.uci.edu/~gohlke/pythonlibs/

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏孤独的S

Hello,world

一般指C语言,C语言是一门面向过程、抽象化的通用程序设计语言,广泛应用于底层1972年,美国贝尔实验室的 D.M.Ritchie 在B语言的基础上最终设计出了一...

9420
来自专栏孤独的S

python——发送邮件

利用程序来发邮件的作用挺多的,在脚本运行时发送一个邮件给你,然后你可以知道脚本运行了,做到一个实时的监控。

10020
来自专栏蛰虫始航

配置点击就能运行Python程序的bat批处理脚本

在编写和调试程序时,一般我们会在集成编辑环境里写代码和运行,但如果程序比较完善需要快速运行,或者让同事在其他电脑上快速运行时,再打开IDE(Integrated...

42810
来自专栏机器学习算法与Python学习

10招!看骨灰级Pythoner如何玩转Python

pandas是基于numpy构建的,使数据分析工作变得更快更简单的高级数据结构和操作工具。本文为大家带来10个玩转Python的小技巧,学会了分分钟通关变大神!

5520
来自专栏机器学习算法与Python学习

30段极简Python代码:这些小技巧你都Get了么

Python 是机器学习最广泛采用的编程语言,它最重要的优势在于编程的易用性。如果读者对基本的 Python 语法已经有一些了解,那么这篇文章可能会给你一些启发...

12510
来自专栏AI科技大本营的专栏

即学即用的30段Python实用代码

原标题 | 30 Helpful Python Snippets That You Can Learn in 30 Seconds or Less

8930
来自专栏一番码客

python解析xml文件

本来今天准备学习下electron的,结果npm工具的安装真是费了劲,网速差的不得了。为了完成今天的日更,只能放弃,今天来谢谢python的xml解析吧。

9920
来自专栏巴法

7月编程语言排行榜:Python持续增长,稳居第三

原文 | 原文:https://www.tiobe.com/tiobe-index/

8510
来自专栏开源优测

Selenium Webdriver 3.X源码分析之核心remote package

在selenium webdriver Python端,最核心的代码就是在remote包目录下了,因为该目录下定义和实现了我们利用selenium webdri...

11720
来自专栏申龙斌的程序人生

用欧拉计划学习Rust编程(第40~45题)

最近想学习Libra数字货币的MOVE语言,发现它是用Rust编写的,所以先补一下Rust的基础知识。学习了一段时间,发现Rust的学习曲线非常陡峭,不过仍有快...

8620

扫码关注云+社区

领取腾讯云代金券

年度创作总结 领取年终奖励