editables_library_editable_install_redirection_project_quickstart.py

1from editables import EditableProject
2
3# Create a new editable project
4# The name should be the project name
5project = EditableProject("my_project", "/path/to/project/root")
6
7# Add a package to the project
8# This is where your source code is located
9project.add_to_path("src")
10
11# Map a package name to its location
12# This tells the project that 'mypackage' is in 'src/mypackage'
13project.map_module("mypackage", "src/mypackage")
14
15# Generate the redirection files
16# This creates the .pth or proxy files needed for the editable install
17for filename, content in project.files():
18    with open(filename, "w") as f:
19        f.write(content)