Better documentation for path dependencies.

[wieczyk]

Hi,

I have recently discovered poetry tool and trying to adapt my project to use it (it is project delivering many packages, in the same spirit as one C++ CMake project can deliver many libraries). One poetry feature bring my attention to use it as my build/package system -- path dependencies. Unfortunately, using them is introducing some issues: packages cannot work with pip install or even poetry cannot build correct wheel packages.

I think the poetry documentation should be updated to mention known issues and save time for new users. Since even wheels cannot be correctly build, it would be worth to mention what is usecase for path dependencies that works now.

[dimbleby]

Docs merge requests are generally welcome!

[neersighted]

Relative path dependencies cannot be built into wheels because they don't make much sense -- see the upstream issue at pypa/pip#6658. It's a limitation of the ecosystem (and relative path deps in a index-uploadable and universally installable package format don't strike me as something most people would think to try).

The intention of path deps is to allow for local dependencies during development and the very nascent foundation of something like #2270.

In general, I think Poetry's docs have assumed too much familiarity with the Python packaging ecosystem. We need to work on making them more accessible for those that are not extensively familiar with how all the other tooling in this space works. That being said, I'm not convinced that this particular limitation of the ecosystem makes sense to call out with more than a note, especially as it is not a known issue, but a rare gotcha.