Skip to content

Default for the include flag is sdist only, not sdist AND wheel #8698

@rdauncey53

Description

@rdauncey53
  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

I was hitting a bunch of issues trying to include resource files in my Poetry build using the include key. It turns out that despite the docs saying that

If no format is specified, it will default to include both sdist and wheel.

It in fact seems to default to only sdist. The workaround was to change

include = "my_folder"

to

include = [
    { path = "my_folder", format = ["sdist", "wheel"] }
]

In addition to this, I find the documentation unclear / challenging in terms of understanding how to access these files when pulling the package in as a dependency. If the files aren't included in the module, I am struggling to get importlib.resources to work.

If it is required that files the package needs to access live inside the package folder, please could this be added to the documentation? If not, could you add some guidance on this?

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsDocumentation issues/improvements

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions