Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Investigate how to make .pyi stubs work in --editable installs #1309

Open
feltech opened this issue May 15, 2024 · 0 comments
Open

Investigate how to make .pyi stubs work in --editable installs #1309

feltech opened this issue May 15, 2024 · 0 comments
Milestone

Comments

@feltech
Copy link
Member

feltech commented May 15, 2024

What

Investigate whether and how IDEs can make use of .pyi stub files for our _openassetio module in a pip --editable install.

Why

We do not install .pyi stub files as part of a pip --editable install, since during development of #1306 neither PyCharm nor VS Code could made to make use of them. The effort to make this work was abandoned due to running out the clock, and this follow-up issue made instead.

During development of OpenAssetIO itself it would be very useful to work in --editable mode, such that IDEs provide code completions for both a recently compiled extension module as well as the live in-progress sources. Currently we have to choose one or the other.

@feltech feltech added this to the v1.0.0 milestone May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant