is it possible to have a package directory name different from the name of the module that should be imported?

[vmgustavo]

I see it is possible to have a package name different from the directory containing the source files (#705).

Using an example pyproject.toml file:

[tool.poetry]
name = "pkg_name"
# ...
packages = [
    {include = "pkg_module"}
]

In this case I would import the module using import pkg_module and not pkg_name. Is it possible to have the name different from the directory name and yet import the module using pkg_import_name or something similar? Am I forced to rename the source directory to the name I want the user to import?

[dimbleby]

what did you try so far? did it work?

[dimbleby]

what did you try so far?

I expect that the example you give in your question just works, try again

[dimbleby]

Or possibly we're at cross-purposes and what you're asking is not a poetry question at all. Are you asking whether python modules have to have the same name as their folder? You should go to the python documentation for such questions.

[vmgustavo]

yes the example works. but it does not get the result I wanted. indeed maybe we're at cross-purposes but I wanted to know if poetry supports it, if it doesn't I will adapt myself to what is available.

[dimbleby]

I don't think you have a question about what poetry supports, I think you have a question about how import works.

python's import will work the same way whether or not you have a pyproject.toml nearby.

if you can achieve what you want without poetry, then poetry should be able to package that up.
if you can't, then poetry has no magic

[okainov]

I got the same question, I was under impression that to should do exactly that... But apparently this doesn't work.

File structure:

| myfancypackage
| - .....
| README.md
| pyproject.toml

TOML

[tool.poetry]

name = "mypackage"
packages = [
    { include = "myfancypackage",  to = "notsofancypackage" },

]

Expectation: user does pip install mypackage, then in Python does import notsofancypackage.
Reality - to does absolutely nothing in this case, no error neither. Only import myfancypackage works.

Maybe I don't get then what to does...