Python将自己的Py文件（或包）发布至pip上

最新推荐文章于 2024-06-06 11:10:47 发布
最新推荐文章于 2024-06-06 11:10:47 发布
阅读量1.1k 收藏 5
点赞数 7
文章标签： python pip pygame
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wo_shi_ID/article/details/129627913
版权

Python将自己的Py文件（或包）发布至pip上

开始

前几天本来是做了一个关于pgzero的模板文件，想发布到pip上面，但在CSDN上搜了114514年却没有任何成果。因为CSDN上只有关于上传python包的。最后是问了chatGPT才解决了问题，也算为CSDN补了个缺口吧！

只打包一个py文件

第一步在Pypi和Github上拥有自己的账号

上传一个py文件，首先需要在Pypi和Github上有账号。已经有了的同学可以直接去下一步
而本作者又比较懒，不想写这部分，所以请去其他博客康康。

第二步——有一个python库~

如果你想将自己的Python库发送至pip首先你得有个py文件
我的python库是长这样的：

/pgzero_template
----/pgzero_template.py
----/setup.py
----/README.md
----/LICENSE

其中pgzero_template文件夹只是一个单纯的目录，取任何名字皆可。只是用于区分其他文件。
pgzero_template.py是库，即你的库的核心文件（虽然也只有一个文件（bruh））
README.md是你库的长描述文件，后期我们对库的描述都在这里面
setup.py是将项目打包的文件
LICENSE（注：没有后缀名）是库的许可证书，可以在Pypi上获取

pgzero_template.py

接下来让我们挨个分析文件夹里面的文件。首先是pgzero_template.py。这是你的库文件。我的库文本如下：

"""
@author: xiaofengkz
@date: 2023-2-25
pgzero的template程序（模板文件）
pgzero本身就是pygame的简化版本，但是我——xiaofengkz又把他简化了一下
使用方法:
    :from template import * #必须得这样，否则无法运行
提供方法:
    :template_draw(screen, bg=(255, 255, 255)
    :template_update()
    :template_on_key_down(keys, key)
    :template_on_key_up(keys, key)
    :template_on_key_down_ESCAPE()
    :template_on_mouse_down(mouse, pos, button)
    :template_on_mouse_up(mouse, pos, button)
    :play_music(music_name='bg_music')
    :stop_music()
    :play_sound(sound_name)
How to use them:
    Some examples:
        :def draw():
            template_draw(screen)
        :def update():
            template_update()
        ...and so on

开源包，任何人都可以使用并修改！
"""
import sys
import os
from pgzrun import *
import re

__version__ = '2.4'

LETTERS = list('ABCDEFGHIJKLMNOPQRSTUVWXYZ')
LETTERS.append('ESCAPE')
LETTERS.append('SPACE')
LETTERS.append('RIGHT')
LETTERS.append('LEFT')
LETTERS.append('UP')
LETTERS.append('DOWN')
# BG = (255, 255, 255)
WIDTH = 1200
HEIGHT = 800

def template_draw(screen, bg=(255, 255, 255)):
    screen.fill(bg)
    for var in mod.__dict__:
        if re.match('draw_.+',var):
            function = getattr(mod,var)
            function(screen)

def template_update():
    for var in mod.__dict__:
        if re.match('update_.+',var):
            function = getattr(mod,var)
            function()
            
def template_on_key_down(keys,key):
    for letter in LETTERS:
        if key == getattr(keys,letter):
            for var in mod.__dict__:
                if var == 'on_key_down_{}'.format(letter):
                    function = getattr(mod,var)
                    function()
                    
def template_on_key_up(keys,key):
    for letter in LETTERS:
        if key == getattr(keys,letter):
            for var in mod.__dict__:
                if var == 'on_key_up_{}'.format(letter):
                    function = getattr(mod,var)
                    function()
                    
def on_key_down_ESCAPE():
    sys.exit()
    
def _none(pos):pass
    
def template_on_mouse_down(mouse,pos,button):
    if button == mouse.LEFT:
        function = getattr(mod,'on_mouse_left_down',_none)
        function(pos)
    if button == mouse.RIGHT:
        function = getattr(mod,'on_mouse_right_down',_none)
        function(pos)
    if button == mouse.MIDDLE:
        function = getattr(mod,'on_mouse_middle_down',_none)
        function(pos)
    
def template_on_mouse_up(mouse,pos,button):
    if button == mouse.LEFT:
        function = getattr(mod,'on_mouse_left_up',_none)
        function(pos)
    if button == mouse.RIGHT:
        function = getattr(mod,'on_mouse_right_up',_none)
        function(pos)
    if button == mouse.MIDDLE:
        function = getattr(mod,'on_mouse_middle_up',_none)
        function(pos)

def play_music(music_name='bg_music'):
    getattr(mod, 'music').play(music_name)
def stop_music(): getattr(mod, 'music').stop()
def play_sound(sound_name):
    getattr(getattr(mod, 'sounds'), sound_name).play()

在文件中你必须要添加一个__version__变量，用于填写库的版本号，在后期如果要更新库，需要将__version__的值改为更高的版本号。

README.md

这里面只需要写一下库的详细描述即可。
这是我的：

A template for pgzero.
You can use it to type pgzero-file more quickly.
You only should type some like this:
"
from pgzero_template import *
"

LICENSE

LICENSE文件文本可以在这里挑选
这是我的LICENSE文件：

MIT License

Copyright (c) [year] [fullname]

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.py

setup.py文件如下：

#!python
# -*- coding:utf-8 -*-
from __future__ import print_function
from setuptools import setup, find_packages
import pgzero_template

with open("README.md", "r", encoding='utf-8') as fh:
    long_description = fh.read()

setup(
    name="pgzero_template",
    version=pgzero_template.__version__,
    author="xiaofengkz",
    author_email="xiaofengkz@163.com",
    description="a template for pgzero",
    long_description=long_description,
    long_description_content_type="text/markdown",
    license="MIT",
    url="https://github.com/zhec5hl01/python-games",
    py_modules=['pgzero_template'],
    install_requires=[
        "pgzero <= 1.2.1",
        "pygame <= 2.1.2"
        ],
    classifiers=[
        "Topic :: Games/Entertainment ",
        'Topic :: Games/Entertainment :: Puzzle Games',
        'Topic :: Games/Entertainment :: Board Games',
        "Topic :: Software Development :: Libraries :: Python Modules",
        "Programming Language :: Python",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.5",
        "Programming Language :: Python :: 3.5",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        'Programming Language :: Python :: Implementation :: CPython',
    ],
)

name 是包名。发布之前请上 PyPi 搜索一下有没有同名的包，防止冲突。
version 是版本号，更新的时候会寻找比当前版本更高的版本号，所以不要乱写。
description是短描述，一般是一句话。
long_description是长描述，详细的介绍。我直接读入了 README.md.
url是你项目的地址。一般会填 github 地址。
py_modules是库名，在里面填写你的库文件名即可。
install_requires是这个包的所需的依赖。
classifiers 是分类。根据 PyPi Classifiers 填写，至少要包含所用的 Python 版本。

第三步——上传文件

最后的最后，用pip安装一下上传包的必要库：

python -m pip install --user --upgrade setuptools wheel

和

python -m pip install --user --upgrade twine

说明一下：setuptools和wheel用于构建项目；twine用于上传文件至Pypi。
首先检查setup.py语法是否正确：

python setup.py check

若没有错误，就可以构建项目

python setup.py sdist bdist_wheel

结果应该生成三个文件夹

/pgzero_template
----/pgzero_template.egg-info
----/dist
----/build

其中最重要的是dist目录。
接下来就可以正式开始上传了

方法1

在cmd中输入如下代码：

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

输入Pypi的账户与密码即可

方法2

上个方法可能会报错，而且每次都要输入密码，很烦（大悲）
所以还有另个方法：
在C:\Users\用户名创建文件.pypric
若无法创建，直接用cmd解决：

echo a 2>.pypric

在文件中写如下：

[distutils]
index-servers=pypi

[pypi]
repository = https://upload.pypi.org/legacy/
username: [username]
password: [password]

这样就可以直接输入cmd

twine upload dist/*

过一段时间，就上传成功惹！！！

尝试导入自己的项目

可以用pip来尝试安装自己的库。

python -m pip install pgzero-template

在用python测试一下：

from pgzero_template import *

def draw():
	template_draw(screen)

def update():
	template_update()

def on_key_down(key):
	template_on_key_down(keys, key)

上传一个python包

很很很很很很简单~只需要稍加修改一下刚刚的文件即可

/pgzero_template
----/pgzero_template
--------/__init__.py
--------/和其他py文件……
----/以及我刚刚说过的文件……

同时setup.py也需要一些修改：

#!python
# -*- coding:utf-8 -*-
from __future__ import print_function
from setuptools import setup, find_packages
import pgzero_template

with open("README.md", "r", encoding='utf-8') as fh:
    long_description = fh.read()

setup(
    name="pgzero_template",
    version=pgzero_template.__version__,
    author="xiaofengkz",
    author_email="xiaofengkz@163.com",
    description="a template for pgzero",
    long_description=long_description,
    long_description_content_type="text/markdown",
    license="MIT",
    url="https://github.com/zhec5hl01/python-games",
    packages=find_packages(),
    install_requires=[
        "pgzero <= 1.2.1",
        "pygame <= 2.1.2"
        ],
    classifiers=[
        "Topic :: Games/Entertainment ",
        'Topic :: Games/Entertainment :: Puzzle Games',
        'Topic :: Games/Entertainment :: Board Games',
        "Topic :: Software Development :: Libraries :: Python Modules",
        "Programming Language :: Python",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.5",
        "Programming Language :: Python :: 3.5",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        'Programming Language :: Python :: Implementation :: CPython',
    ],
)

只需要py_modules参数改为packages，值改为find_packages()函数。

结束语

咳咳……终于讲完了！这是我的第一个博客，可能有些不好，请谅解！希望本博客能为各位码农提供帮助！！！

小凤kz
关注
  • 7
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
将python包发布到PyPI和制作whl文件
winycg的博客
04-20 3万+
参考链接： wheel和egg的不同 怎样将自己写的包传达到PyPi 发布你自己的轮子 - PyPI打包上传实践 PyPI官网上传包教程 wheel文件 Wheel和Egg都是python的打包格式，目的是支持不需要编译或制作的安装过程，实际上也是一种压缩文件，将.whl的后缀改为.zip即可可看到压缩包里面的内容。按照官网说法，wheels是发行版Python的新标准并且要取代....
上传属于自己的python第三方库
m0_62919535的博客
07-04 719
学过 python 的都知道是用 pip 安装包。秉持着开源精神，是否也想把自己写的包上传到 pypi ，供大家下载分享呢？因为我一直都有整理代码的习惯，所有这一年多累加了很多图像处理方面的代码，平时也会用自己写的私库函数，但有时候因为要删删减减的，调换函数位置，不是很方便，最近也是查了很多的资料，也是成功的将库上传到了pypi网站中。我发现网上对这方面的资料很有限，不知道是不是大佬不重视，还是因为有其他的原因，这里我就带大家走一遍这个流程。欢迎大家下载并使用我的第三方库。
python如何发布自己开发的库
最新发布
网络爬虫开发
06-06 328
日常工作中我们自己会编写许多的python 函数用来处理特定的事情，在我的工作中就有这样的一个函数，专门用来检测化合物的唯一标识符CAS NO是否符合国际的标准。在工作中使用的很频繁，而且又是通用型的检测方法，因此我想把这个库封装一下并发布到pypi上面，方便我部署的时候可以直接下载，也减少了我的项目代码的量及复杂度。8.发布dist文件下的.whl到pypi服务器（按提示输入用户名、密码）（这里需要特别注意：以前时可以直接使用账号和密码发布的但是现在增加了安全验证需要api token）
Python: 打包发布到PyPi及踩坑经历
Julia & Rust & Python
11-21 4935
经常会碰到python包要打包成sdk放到PyPi上开源的情况。 下面的操作具体参考：https://packaging.python.org/en/latest/tutorials/packaging-projects/。
发布自己的Python库
sailist的记录站
08-01 577
这两天为了方便，折腾了一下自己的写的一个工具，研究了一下怎么发布自己的Python库，记录在此，主要介绍以下内容 Python库发布的完整过程 通过Python库发布自己的命令行工具的方法 检查目录组织 要发布Python库，首先要检查自己的目录组织是否符合编译程序的要求，以我的库MarkTex为例，目录树结构如下： . ├── MANIFEST.in ├── marktex │ ├── ...
python库发布之从零到一：发布自己的第一个库——blogdownloader
Together_CZ的博客
03-21 2658
python很强大一个很重要的特点就是有很海量的第三方库和包可以直接拿来使用，省去了很多不必要的工作，之前一直都是各种导包，“import ***”，一直没有时间去自己鼓捣一个库，尝试一下写库的乐趣，今天难得有一点时间，索性直接来实践一下吧，从零到一简单实现发布自己的第一个库——blogdownloader，地址在这里，截图如下： 项目非常的简单，主要做的就...
python2.7中所用的get-pip.py文件+安装方法
12-15
在Python的生态系统中，`pip`是一个至关重要的工具，它是Python的包管理器，用于安装和管理软件包。对于Python 2.7这样的较旧版本，`pip`同样不可或缺，因为它允许开发者获取和安装各种库和依赖项，从而扩展Python的...
python py7zr资源包
07-03
在没有网络条件或者pip安装不便的情况下，你可以选择直接下载这个资源包，解压缩后将其放置到你的项目文件夹中，这样就可以本地化地使用py7zr库进行7z文件的相关操作。 Python的py7zr库提供了与7-Zip软件兼容的功能...
详解Python3.6的py文件打包生成exe
12-23
1. Python版本32位 （文件名为 python-3.6.1.exe） 2. 安装所有用到的模块（原文博主用的是openpyxl，我用到的有urllib中的request\config\data） 3. 下载替换pyinstaller（下载pyinstaller-develop.zip，复制其中的...
python3安装pip指令文件
08-15
这个文件是Python官方提供的一个Python脚本，用于在各种平台上安装pip。以下是安装步骤： 1. **解压文件**： 在收到“get-pip.py”文件后，你需要将其解压缩。如果你的文件已经是未压缩的，那么可以跳过这一步。...
Python基于pip实现离线打包过程详解
09-16
接着，运行`pip install --no-index --find-index=d:\python3.6\temp -r requirements.txt`，这个命令告诉pip不要去网络上查找包，而是从指定的本地目录`d:\python3.6\temp`中寻找并安装。 3. **非离线状态下安装**...
项目的打包和上传pypi
qq_46273065的博客
02-19 190
将Python 项目打包到 Pypi
【Python包管理系列1】python打包发布到PyPI全过程（入门版）
量化投资助手的博客
09-24 1882
这是一个最简单的发布过程，并不一定会满足所有情况，比如我们想打包一些额外的文件，想撰写包的描述等，这些工作可能都是我们需要的。但是，build工具的官方文档极其简单，并没有过多的关于这些配置的说明，实现起来很容易摸不到头脑。Peotry，用它来管理包和发布包将会更简单，后面发文分享。
如何发布pip可以直接安装的包（2021.12更新，针对最近网站变动）
weixin_44886683的博客
12-11 835
1.创建一个文件夹，大概形式是 pippackage ├── setup.py ├── README.rst └── yourpackagename ├── __init__.py └── 一些要调用的方法的py文件 setup.py是必须的 # -*- coding: utf-8 -*- ############################################# # File Name: setup.py # Author: Yixin xx # Mail: xxxx
如何上传你的python包到PyPi
@bangbang的博客
03-11 2455
介绍如何将代码上传到PyPi，并通过pip install 方式供所有人进行下载 注册Pypi账号 Pypi账号注册 2. 创建上传代码的项目工程 让我们为上传准备代码。首先，应该从代码中删除所有的“print”语句。当您在使用库时，命令提示符中充斥着不属于您的打印消息，这是很烦人的——因此请将它们全部删除。如果您想要通知用户某些活动，请使用日志记录。 还要确保不要包含存在于函数类之外的代码，否则每次有人导入你的库时，这段代码都会运行。如果你想在类中包含示例代码(这是合法的)，把它包装到" __mai
python 的库如何开发_如何发布自己的Python库？
weixin_39815943的博客
11-20 400
前言与简介我想任何一个有追求的Python开发者在度过基础阶段后都想过发布自己的库，也就是我们常说的造轮子，这是成为一个成熟Python开发者的第一步，在造轮子的过程中，无论是自己的编程能力还是为以后给开源项目贡献代码的能力都会得到很大提升。今天这篇博客，就来带大家从0开始，向PyPI贡献自己的开源库。进入正文之前先说一下自己造轮子的步骤：主体程序设计与编写编写setup.py编写使用文档发布到P...
关于创建Python库
weixin_42246860的博客
06-20 7646
相信会Python的人一定会了解不少的库，而且也想创建自己的Python库，其实创建Python库并不是一件很难的事情，下面就来教大家如何创建Python库。注:以下方法仅适用于Windows需要文件:setup.py你要创建成库的Python文件的文件名.pyREADME.txt （发布描述）一个存放以上所有文件的文件夹当以上文件都准备好后，就要开始写代码了。首先是setup.py:from s...
pip最详细发布教程(含非包文件打包上传)
qq_41966009的博客
01-13 1008
MANIFEST.in include
将python包上传到PyPI
libbyandhelen的博客
12-15 2815
目标：将自己写的python包上传到PyPI上，这样其他人就可以用pip下载了总体文件结构：--- Root directory (name doesn't matter) |- your_library | |- __init__.py | |- actual_code_goes_here.py |- setup.py |- README.rst |- LICENSE.txt创建s
python 将py文件打包为exe
05-23
你可以使用 PyInstaller 将 Python 脚本打包为可执行文件（exe）。 以下是 PyInstaller 的使用方法： 1. 首先，你需要安装 PyInstaller。可以使用 pip 命令进行安装： ``` pip install pyinstaller ``` 2. 在...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值