百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

python散装笔记——80: 创建 Python 程序包

itomcoil 2025-02-20 15:56 27 浏览

1: 简介

每个软件包都需要一个描述软件包的 setup.py 文件。

下面是一个简单软件包的目录结构:

+-- package_name
| |
| +-- __init__.py
|
+-- setup.py

__init__.py 只包含一行 def foo(): return 100

下面的 setup.py 将定义软件包:

from setuptools import setup

setup(
  name='package_name', # package name
  version='0.1', # version
  description='Package Description', # short description
  url='http://example.com', # package URL
  install_requires=[], # list of packages this package depends on.
  packages=['package_name'], # List of module names that installing this package will provide.
)

virtualenv 是测试软件包安装的好帮手,无需修改其他 Python 环境:

$ virtualenv .virtualenv
...
$ source .virtualenv/bin/activate
$ python setup.py install
running install
...
Installed .../package_name-0.1-....egg
...
$ python
>>> import package_name
>>> package_name.foo()
100

2: 上传到 PyPI

一旦您的 setup.py 功能完善(见上一节),就可以非常容易地将软件包上传到 PyPI。(本节和下节内容暂不演示)

设置 .pypirc 文件

该文件存储用于验证账户的登录名和密码。它通常保存在你的主目录中。

# .pypirc file

[distutils]
index-servers =
  pypi
  pypitest

[pypi]
repository=https://pypi.python.org/pypi
username=your_username
password=your_password

[pypitest]
repository=https://testpypi.python.org/pypi
username=your_username
password=your_password

使用 twine 上传软件包更安全,因此请确保安装了 twine。

$ pip install twine

注册并上传到 testpypi(可选)

注意:PyPI 不允许覆盖已上传的软件包,因此最好先在专用测试服务器(如 testpypi)上测试你的部署。我们将讨论这一选项。在上传之前,考虑对软件包进行版本控制,例如日历版本控制或语义版本控制。

登录或在 testpypi 创建一个新账户。只有第一次注册时才需要,但多次注册也无妨。

$ python setup.py register -r pypitest

而在软件包的根目录下:

$ twine upload dist/* -r pypitest

现在应该可以通过您的账户访问您的软件包了。

测试

创建一个测试虚拟环境。尝试从 testpypiPyPI 安装你的软件包。

# Using virtualenv
$ mkdir testenv
$ cd testenv
$ virtualenv .virtualenv
...
$ source .virtualenv/bin/activate
\# Test from testpypi
(.virtualenv) pip install --verbose --extra-index-url https://testpypi.python.org/pypi package_name
...
# Or test from PyPI
(.virtualenv) $ pip install package_name
...

(.virtualenv) $ python
Python 3.5.1 (default, Jan 27 2016, 19:16:39)
[GCC 4.2.1 Compatible Apple LLVM 7.0.2 (clang-700.1.81)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import package_name
>>> package_name.foo()
100

如果成功,您的软件包至少是可导入的。在最终上传到 PyPI 之前,您也可以考虑测试一下您的 API。如果你的软件包在测试过程中失败了,不要担心。您仍然可以修复它,重新上传到 testpypi 并再次测试。

注册并上传到 PyPI

确保安装了 twine

$ pip install twine

Either log in, or create a new account at PyPI.

$ python setup.py register -r pypi
$ twine upload dist/*

就是这样!你的软件包已经上线。

如果发现错误,只需上传新版本的软件包即可。

文档

别忘了至少为你的软件包提供一些文档。PyPi 默认使用 reStructuredText 作为格式化语言。

自述文件

如果您的软件包没有大量的文档,请在 README.rst 文件中加入对其他用户有帮助的内容。文件准备好后,还需要另一个文件来告诉 PyPi 显示它。

创建 setup.cfg 文件,并在其中加入这两行:

[metadata]
description-file = README.rst

请注意,如果您尝试将 Markdown 文件放入您的软件包,PyPi 将把它作为一个纯文本文件来读取,不带任何

格式化。

许可

通常情况下,我们非常欢迎在您的软件包中放入一个 LICENSE.txt 文件,其中包含一个开源许可证,以告诉用户他们是否可以在商业项目中使用您的软件包,或者您的代码是否可以使用他们的许可证。

一些许可证的可读性说明见 TL;DR

3: 使软件包可执行

如果你的软件包不仅是一个库,而且还有一段代码,在安装软件包后可以作为展示程序或独立应用程序使用,请将这段代码放到 __main__.py 文件中。

__main__.py 文件放到 package_name 文件夹中。这样,你就可以直接从控制台运行它了:

python -m package_name

如果没有可用的 __main__.py 文件,软件包将无法使用此命令运行,并将打印此错误信息:

python: 没有名为 package_name.__main__ 的模块;'package_name' 是一个包,不能直接执行。

相关推荐

MySQL修改密码_mysql怎么改密码忘了怎么办

拥有原来的用户名账户的密码mysqladmin-uroot-ppassword"test123"Enterpassword:【输入原来的密码】忘记原来root密码第一...

数据库密码配置项都不加密?心也太大了吧!

先看一份典型的配置文件...省略...##配置MySQL数据库连接spring.datasource.driver-class-name=com.mysql.jdbc.Driverspr...

Linux基础知识_linux基础入门知识

系统目录结构/bin:命令和应用程序。/boot:这里存放的是启动Linux时使用的一些核心文件,包括一些连接文件以及镜像文件。/dev:dev是Device(设备)的缩写,该目录...

MySQL密码重置_mysql密码重置教程

之前由于修改MySQL加密模式为mysql_native_password时操作失误,导致无法登陆MySQL数据库,后来摸索了一下,对MySQL数据库密码进行重置后顺利解决,步骤如下:1.先停止MyS...

Mysql8忘记密码/重置密码_mysql密码忘了怎么办?

Mysql8忘记密码/重置密码UBUNTU下Mysql8忘记密码/重置密码步骤如下:先说下大概步骤:修改配置文件,使得用空密码可以进入mysql。然后置当前root用户为空密码。再次修改配置文件,不能...

MySQL忘记密码怎么办?Windows环境下MySQL密码重置图文教程

有不少小白在使用Windows进行搭建主机的时候,安装了一些环境后,其中有MySQL设置后,然后不少马大哈忘记了MySQL的密码,导致在一些程序安装及配置的时候无法进行。这个时候怎么办呢?重置密码呗?...

10种常见的MySQL错误,你可中招?_mysql常见错误提示及解决方法

【51CTO.com快译】如果未能对MySQL8进行恰当的配置,您非但可能遇到无法顺利访问、或调用MySQL的窘境,而且还可能给真实的应用生产环境带来巨大的影响。本文列举了十种MySQL...

Mysql解压版安装过程_mysql解压版安装步骤

Mysql是目前软件开发中使用最多的关系型数据库,具体安装步骤如下:第一步:Mysql官网下载最新版(mysql解压版(mysql-5.7.17-winx64)),Mysql官方下载地址为:https...

MySQL Root密码重置指南:Windows新手友好教程

如果你忘记了MySQLroot密码,请按照以下简单步骤进行重置。你需要准备的工具:已安装的MySQL以管理员身份访问命令提示符一点复制粘贴的能力分步操作指南1.创建密码重置文件以管理员...

安卓手机基于python3搜索引擎_python调用安卓so库

环境:安卓手机手机品牌:vivox9s4G运行内存手机软件:utermux环境安装:1.java环境的安装2.redis环境的安装aptinstallredis3.elasticsearch环...

Python 包管理 3 - poetry_python community包

Poetry是一款现代化的Python依赖管理和打包工具。它通过一个pyproject.toml文件来统一管理你的项目依赖、配置和元数据,并用一个poetry.lock文件来锁定所有依赖的精...

Python web在线服务生产环境真实部署方案,可直接用

各位志同道合的朋友大家好,我是一个一直在一线互联网踩坑十余年的编码爱好者,现在将我们的各种经验以及架构实战分享出来,如果大家喜欢,就关注我,一起将技术学深学透,我会每一篇分享结束都会预告下一专题最近经...

官方玩梗:Python 3.14(πthon)稳定版发布,正式支持自由线程

IT之家10月7日消息,当地时间10月7日,Python软件基金会宣布Python3.14.0正式发布,也就是用户期待已久的圆周率(约3.14)版本,再加上谐音梗可戏称为π...

第一篇:如何使用 uv 创建 Python 虚拟环境

想象一下,你有一个使用Python3.10的后端应用程序,系统全局安装了a2.1、b2.2和c2.3这些包。一切运行正常,直到你开始一个新项目,它也使用Python3.10,但需要...

我用 Python 写了个自动整理下载目录的工具

经常用电脑的一定会遇到这种情况:每天我们都在从浏览器、微信、钉钉里下各种文件,什么截图、合同、安装包、临时文档,全都堆在下载文件夹里。起初还想着“过两天再整理”,结果一放就是好几年。结果某天想找一个发...