一个用于创建 "可编辑的wheel" 的Python库

此库支持构建wheel，当安装时，将暴露包在本地目录上的 sys.path 中，以 "可编辑模式"。换句话说，对包源代码的更改将在Python可见的包中反映出来，而无需重新安装。

用法

假设您想要为您的项目 foo 构建 wheel。您的项目位于目录 /path/to/foo 中。在该目录下，您有一个包含您的项目的 src 目录，该目录是一个名为 foo 的包和一个名为 bar.py 的Python模块。因此，您的目录结构如下

/path/to/foo
|
+-- src
|   +-- foo
|   |   +-- __init__.py
|   +-- bar.py
|
+-- setup.py
+-- other files

按如下方式构建您的 wheel

from editables import EditableProject

my_project = EditableProject("foo", "/path/to/foo")
my_project.add_to_path("src")

# Build a wheel however you prefer...
wheel = BuildAWheel()

# Add files to the wheel
for name, content in my_project.files():
    wheel.add_file(name, content)

# Record any runtime dependencies
for dep in my_project.dependencies():
    wheel.metadata.dependencies.add(dep)

构建的 wheel 在安装时，将项目 src 目录放置在 sys.path 上，以便在不重新安装的情况下编辑原始源代码（即，作为 "可编辑" 包）。通过在 wheel 中添加一个名为项目的单个 .pth 文件，将项目暴露在 sys.path 上。

有关更多详细信息，包括如何更精确地控制暴露的内容，请参阅 文档。

请注意，此项目不会直接构建 wheel。这是调用代码的责任。

Python 兼容性

本项目支持与pip相同的Python版本。目前是Python 3.7及其以后版本，以及PyPy3（尽管我们没有在PyPy上进行测试）。