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

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

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

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是目前最流行的关系型数据库管理系统,在WEB应用方面MySQL是最好的RDBMS(RelationalDatabaseManagementSystem:关系数据库管理系统)应用软件...

使用AI来搭建一个用户系统,步骤应该是怎样的呢?

我给AI的第一个问题是这样的:创建一个java21+springboot3.4+mysql21的一个用户系统,需要使用JWT,支持多语言,使用swagger,这个用户系统都应该包含哪...

Mysql 8.4数据库安装、新建用户和数据库、表单

1、下载MySQL数据库yuminstall-ywgetperlnet-toolslibtirpc#安装wget和perl、net-tools、libtirpcwgethtt...

介绍如何在 MySQL 中创建新用户并授予权限?

MySQL是一个开源的关系型数据库管理系统,常用于存储和管理大量的结构化数据。在使用MySQL进行数据管理时,为了安全和方便管理,通常需要创建新用户并授予相应的权限。本文将介绍如何在MySQL...

Mysql创建用户和权限管理

MySQL是一个多用户的数据库,最高权限管理者是root用户,它拥有着最高的权限操作。包括select、update、delete、update、grant等操作。如果有其他用户想使用MySQL,那么...

Mysql:创建用户详解

1、创建并授权用户--创建可从任何主机连接的用户CREATEUSER'myuser'@'%'IDENTIFIEDBY'mypassword'...

Python 实现【字符匹配】

defis_match(s,pattern):m,n=len(s),len(pattern)dp=[[False]*(n+1)for_inrange...

Python自动化:openpyxl工作簿、工作表相关操作

新建工作簿、工作表importopenpyxl#创建空白工作簿,会自动生成一个工作表:Sheetwb=openpyxl.Workbook()#新建工作表#create_sheet...

python每日一练之三数排序

概述今天主要分享一个三树排序的实例,大家可以自己测试玩一下~需求输入三个整数x,y,z,请把这三个数由小到大输出。方法一:如果是要练练手就随便找个排序算法实现一下#usr/bin/python#...

Python输出语句print()

Python中的输出语句主要通过内置函数print()实现,它可以灵活输出文本、变量、表达式结果等内容到控制台或其他文件。以下是详细介绍及示例:一、print()基本语法print(*object...

Python设置excel表格格式,这3个属性6个模块,要表格好看

前言:通过前面两篇文章,我们用Python处理excel数据得到了结果并保存了文件。打开文件会发现,文件里表格是没有设置格式的,还需手动调整行高列宽等样式,很麻烦。其实,通过Python库模块,能轻松...

python入门-day5-循环语句

以下是为“Day5:循环语句”设计的详细学习任务计划。这个任务旨在帮助初学者掌握Python中的循环语句(for和while),并通过实践理解它们的应用场景。Day5:循环语句学习目标...

Python基础编程必备!涵盖常见语法与操作的代码示例合集

以下是一份Python基础代码示例合集,涵盖了常见的语法和操作,适合初学者快速掌握基本编程概念:1.基础语法python#打印输出print("Hello,World!")#变...

Python循环语句实用教程

一、循环基础1.while循环基本语法:while条件表达式:循环体代码while循环流程图:应用示例:#简单计数器count=0whilecount<5:...

在 Python 中如何向一个已排序的数组(列表) 中插入一个数呢

在Python中如何向一个已排序的数组(列表)中插入一个数呢?方法有很多种,关键在于原来数组是什么样的排序,用到啥排序方法效率高,就用哪种。我们来练习其中的几种插入方法,另外也掌握下遍历数组的...