Skip to main content

简单打包的简单打包工具。

项目描述

Flit是一种将 Python 包和模块放在 PyPI 上的简单方法。它试图减少对包装的考虑,并帮助您避免常见错误。请参阅为什么使用 Flit?有关它与其他 Python 打包工具的比较的更多信息。

安装

$ python3 -m pip install flit

Flit 需要 Python 3,因此需要使用 Python 3 版本的 pip 安装。

Python 2 模块可以使用 Flit 分发,但需要可以在 Python 3 上导入而不会出错。

用法

假设您正在编写一个模块foobar — 作为单个文件foobar.py或作为目录 — 并且您想要分发它。

  1. 确保 foobar 的文档字符串以模块是什么的单行摘要开头,并且它有一个__version__

    """An amazing sample package!"""
    
    __version__ = "0.1"
  2. 如果您还没有 flit,请安装它:

    python3 -m pip install flit
  3. 在包含模块的目录中运行flit init以创建 pyproject.toml文件。它看起来像这样:

    [build-system]
    requires = <s>["flit_core >=3.2,<4"]</s>
    build-backend = <s>"flit_core.buildapi"</s>
    
    [project]
    name = <s>"foobar"</s>
    authors = <s>[{name = "Sir Robin", email = "robin@camelot.uk"}]</s>
    dynamic = <s>["version", "description"]</s>
    
    [project.urls]
    Home = <s>"https://github.com/sirrobin/foobar"</s>

    您可以编辑此文件以添加其他元数据,例如设置命令行脚本。请参阅文档的 pyproject.toml 页面

    如果您已经有一个flit.ini文件可用于旧版本的 Flit,请通过运行python3 -m flit.tomlify将其转换为pyproject.toml

  4. 运行以下命令将代码上传到 PyPI:

    flit publish

一旦你的包发布,人们可以像任何其他包一样使用pip安装它。在大多数情况下,pip 会下载一个“wheel”包,这是它知道如何安装的标准格式。如果你特别要求 pip 安装一个 'sdist' 包,它将在临时环境中安装和使用 Flit。

要在本地安装软件包以进行开发,请运行:

flit install [--symlink] [--python path/to/python]

Flit 一次打包一个可导入的模块或包,使用导入名称作为 PyPI 上的名称。包中的所有子包和数据文件都会自动包含在内。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

flit-3.7.1.tar.gz (136.6 kB 查看哈希

已上传 source

内置分布

flit-3.7.1-py3-none-any.whl (49.3 kB 查看哈希

已上传 py3