Why is the wheel dropping files that are in sdist?

[skrawcz]

I have the following in our pyproject.toml

[tool.flit.sdist]
include = [
  "LICENSE",
  "NOTICE",
  "DISCLAIMER",
  "scripts/**",
  "telemetry/ui/**",
  "examples/__init__.py",
  "examples/email-assistant/**",
  "examples/multi-modal-chatbot/**",
  "examples/streaming-fastapi/**",
  "examples/deep-researcher/**",
]

But in the created wheel, only LICENSE is there. The rest is not.

Any ideas for why? There is no wheel configuration directive in flit, right?

[takluyver]

Wheels contain just the pieces that get installed, like the importable package. Sdists conventionally contain things like tests, docs, examples and possibly development scripts, but wheels don't.

If you want some of these files to get installed, how to do that depends on what files you're talking about and where they should go.

[skrawcz]

I think NOTICE AND DISCLAIMER should be in the wheel (either metadata or root) to comply with apache.

I believe I also tried:

license-files = ['LICENSE', 'NOTICE', 'DISCLAIMER']

and it was not added to the wheel.

As for the others:

The burr package actually includes a symlink to the examples directory to pull in those examples -- so they should be pulled via the symlink. examples -> ../examples is what is under burr/.

I think not including the telemetry/ui or scripts is fine with respect to the wheel, but it's required for the source...

[skrawcz]

Okay figured out I needed to add:

license-files = ["LICENSE", "NOTICE", "DISCLAIMER"]

Under [project] ....

Now to fix the examples part. I wonder whether flit doesn't resolve symlinks like build did... ?

[skrawcz]

Yeah I don't think flit resolves symlinks -- which is the issue.

[takluyver]

I think you can probably make this work if you switch the symlink around, so the examples folder is inside the package, and there's a symlink outside pointing to burr/examples. Symlinks aren't exactly supported anywhere, though, even if you can currently get a satisfactory result from some configuration.