对于模块开发者本质上需要做3件事:

  • 编写模块
  • 将模块进行打包
  • 上传到PyPI(需要先注册PyPI账号)
    • 注册PyPI账号
    • 安装上传工具
    • 基于工具进行上传

对于模块的使用者来说,只需要做2件事:

  • 通过pip install 模块去安装模块
  • 调用模块

假设,现在我们要做一个名称叫 zyf_timer 的模块,跟着下面的步骤一步一步的操作。

第一步 项目文件夹

根据要求创建如下文件,并填写内容

zyf_timer
├── LICENSE # 声明,给模块使用者看,说白了就是使用者是否可以免费用于商业用途等。
├── README.md # 模块介绍
├── demos # 使用案例
├── zyf_timer # 模块代码目录
│ └── __init__.py
└── setup.py # 给setuptools提供信息的脚本(名称、版本等)

1.1 License

LICENSE文件就是咱们模块的许可证,给模块使用者看,说白了就是使用者是否可以免费用于商业用途等。一般开源的软件会选择相对宽泛许可证 MIT,即:作者保留版权,无其他任何限制。

Copyright (c) 2021 The Python Packaging Authority

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.

更多其他许可证参见:https://choosealicense.com/

1.2 READNE.md

readme就是对于当前模块的描述信息,一般用于markdown格式编写,如:

### 计时器-zyf_timer

#### 安装

> pip install zyf_timer

#### 使用

```python
from zyf_timer import timeit @timeit
def main():
time.sleep(1)
...
``` 设置保留位数,默认保留两位小数 ```python
from zyf_timer import timeit_with_digit @timeit_with_digit(digit=4)
def main():
time.sleep(1)
...
```

此文件也可以写模块的简单使用手册,如果手册太复杂建议再创建一个doc文件夹存放使用手册。

1.3 demos目录

demos一般会写一些该模块使用的示例,用于使用者快速可以将模块应用到生成中。

1.4 setup.py

setup.py文件其实是一个配置文件,用于给setuptools提供一些模块相关的信息,如:模块名称、模块版本、适用的python版本、作者、github地址等。

# -*- coding: utf-8 -*-

"""
Author : ZhangYafei
Description: timer
""" import setuptools with open("README.md", "r", encoding='utf-8') as fh:
long_description = fh.read() setuptools.setup(
name='zyf_timer', # 模块名称
version="1.0", # 当前版本
author="zhangyafei", # 作者
author_email="zhangyafeii@foxmail.com", # 作者邮箱
description="函数计时器", # 模块简介
long_description=long_description, # 模块详细介绍
long_description_content_type="text/markdown", # 模块详细介绍格式
# url="https://github.com/zhangyafeii/timer", # 模块github地址
packages=setuptools.find_packages(), # 自动找到项目中导入的模块
# 模块相关的元数据
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
# 依赖模块
# install_requires=[],
python_requires='>=3.6',
)

注意:setuptools是一个包管理工具,可用于打包和安装模块。

1.5 zyf_timer目录

插件内容,可以将相关代码在__init__.py编写,

代码内容

最后的文件夹如下:

zyf_timer
├── LICENSE
├── README.md
├── demos
├── zyf_timer
│ ├── __init__.py
└── setup.py

第二步 代码打包&上传

上述步骤中将文件夹和代码编写好之后,就需要对代码进行打包处理。

2.1 安装打包工具(已有无需重复安装)

打包代码需先安装setuptools和wheel两个工具,可以单独安装,也可以安装pip,从而自动安装这两个工具。

注意:已安装用户,如要更新setuptools和wheel两个工具,可通过如下命令:

python -m pip install --upgrade setuptools wheel

2.2 打包代码

python setup.py sdist bdist_wheel

zyf_timer
│ LICENSE
│ README.md
│ setup.py

├─build
│ ├─bdist.win-amd64
│ └─lib
│ └─zyf_timer
│ __init__.py

├─demos
├─dist
│ zyf_timer-2.0-py3-none-any.whl
│ zyf_timer-2.0.tar.gz

├─zyf_timer
│ timer.py
│ __init__.py

└─zyf_timer.egg-info
dependency_links.txt
PKG-INFO
SOURCES.txt
top_level.txt

2.3 发布模块(上传)

文件打包完毕后,需要将打包之后的文件上传到PyPI,如果想要上传是需要先去 https://pypi.org/ 注册一个账号。

    • 安装用于发布模块的工具:twine 【已安装无需重复安装】

python -m pip install --upgrade twine

pip install --upgrade twine
# 提示:python -m 的作用是 run library module as a script (terminates option list)
    • 发布(上传)

python -m twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
    • 上传时,提示需要输入PyPI的用户名和密码.

第三步 安装使用

3.1 安装

pip install zyf_timer

如果提示找不到对应的版本,可能是因为你使用的是国内镜像,刚发布的包还未同步,这时可以指明使用官方源下载。

pip install zyf_timer -i https://pypi.python.org/simple

3.2 应用

import time
from zyf_timer.timer import timeit @timeit
def main():
time.sleep(1) if __name__ == '__main__':
main()

  

上传自己的pip模块的更多相关文章

  1. iOS 上传自己的工程(模块工具类)到cocoapods上遇到坑

    最近在研究把自己写的工具类和模块上传到cocoapods上, 再新构建项目中可以直接使用cocoapods使用  也可以更新之前的版本 便于维护项目. 但是在这个过程中遇到了种种问题 但是最后还是解决 ...

  2. SpringMVC:学习笔记(8)——文件上传

    SpringMVC--文件上传 说明: 文件上传的途径 文件上传主要有两种方式: 1.使用Apache Commons FileUpload元件. 2.利用Servlet3.0及其更高版本的内置支持. ...

  3. 上传第三方jar包至maven私服,以geotools为例

    上传jar包(模块打包方式为jar) mvn deploy:deploy-file -DgroupId=org.geotools -DartifactId=gt-api -Dversion=10.3 ...

  4. 网站日志流量分析采集(LuaJIT系统环境部署-node03,相关jar包自己手动上传)

    注:/usr/local/src 是源码包路径,可以自己更改 服务器中安装依赖 yum -y install gcc perl pcre-devel openssl openssl-devel 上传 ...

  5. nodejs --- 上传文件并保存到磁盘

    先复习下整个请求的过程 const express = require('express'); const static = require('express-static'); const cook ...

  6. angularjs结合plupload实现文件上传

    转载注明:(罗志强的博客) angularjs的指令directive非常好使,可以很方便的结合各种插件,实现很强大的功能. 今天用到了plupload,就拿它举例吧. 正常的plupload用法应该 ...

  7. Nginx + Lua搭建文件上传下载服务

    收录待用,修改转载已取得腾讯云授权 最新腾讯云技术公开课直播,提问腾讯W3C代表,如何从小白成为技术专家?点击了解活动详情 作者 | 庄进发 编辑 | 迷鹿 庄进发,信息安全部后台开发工程师,主要负责 ...

  8. 转:使用 Nginx Upload Module 实现上传文件功能

    普通网站在实现文件上传功能的时候,一般是使用Python,Java等后端程序实现,比较麻烦.Nginx有一个Upload模块,可以非常简单的实现文件上传功能.此模块的原理是先把用户上传的文件保存到临时 ...

  9. vue实现图片的上传和删除

    目录 1 UI库使用ElementUI 2 后端使用Express + formidable模块 1 UI库使用ElementUI 安装ElementUI $ npm install --save-d ...

随机推荐

  1. Service Worker的应用

    Service Worker的应用 Service worker本质上充当Web应用程序.浏览器与网络(可用时)之间的代理服务器,这个API旨在创建有效的离线体验,它会拦截网络请求并根据网络是否可用来 ...

  2. 转:ios delegate

    首先,大家应该都明白的是委托是协议的一种,顾名思义,就是委托他人帮自己去做什么事.也就是当自己做什么事情不方便的时候,就可以建立一个委托,这样就可以委托他人帮自己去实现什么方法. 其次,我简单的总结了 ...

  3. ubuntu 10.04安装和配置Samba

    1. 安装samba服务器 sudo apt-get install samba  //主程序包 sudo apt-get install smbfs  //文件下载挂载工具 2. 创建共享目录 mk ...

  4. Sql中的小技巧

    1.where 字段名 regexp '正则表达式' 正则符号: ^ $ . [ ] * | . 表示1个任意字符 * 表示前面重复0次,或者任意次 ^ 开始 $ 结尾 [] 范围 | 或 sql示例 ...

  5. Spring5 概述及Spring IOC学习

    Spring Framework 5 1. Spring框架 1.1 Spring框架概述 1.2 主要内容 Spring框架是一个开源的JavaEE的应用程序 主要核心是 IOC(控制反转)和AOP ...

  6. React-Router(二)

    URL参数部分 import React from "react"; import { BrowserRouter as Router, Switch, Route, Link, ...

  7. MyBatis中比较(大于、小于)符号的转义写法

    <     < <=   <= >    > >=   >= &     & '     &apos; "     & ...

  8. chrome/microsoft/brave等浏览器离线下载crx并安装(解决download interrupted)

    重要网站 离线下载crx 问题描述 使用chrome/microsoft edge/ brave 下载chrome webstroe插件时,提示: download interrupted. 解决方案 ...

  9. jetson nano开发使用的基础详细分享

    前言: 最近拿到一块jetson nano 2GB版本的板子,折腾了一下,从烧录镜像.修改配件等,准备一篇开箱基础文章给大家介绍一下这块AI开发板. 作者:良知犹存 转载授权以及围观:欢迎关注微信公众 ...

  10. 【LeetCode】409. Longest Palindrome 解题报告(Python & C++)

    作者: 负雪明烛 id: fuxuemingzhu 个人博客: http://fuxuemingzhu.cn/ 目录 题目描述 题目大意 解题方法 方法一:字典统计次数 方法二:HashSet 方法三 ...