Question about hatchling and customizing build outputs

[lwasser]

hey there @ofek 👋 !

Can hatchling allow you to customize what is included in your wheel and sdist. specifically if someone has tests in a structure like this:

package-name/testing/tests

can you configure hatchling in a build to exclude that specific directory but obviously include all of the rest of the package-name directory (containing the API)? many thanks!

[ofek]

Yes. Can you please show me a small tree of the exact directory structure and what you want in the wheel versus source distribution?

[lwasser]

many thanks!

xclim/
   core/
   data/
   ensembles/
   testing/  # <- We want to exclude testing/* directory and all subdirectories and files from the wheel
      tests/
      __init__.py

i am not sure if they will use hatchling - they are using flit-core now but i wanted to know for future as well so we can help people exclude directories from a wheel if they don't need to include tests in that wheel. i can then add this to our guide.

[ofek]

Everything is very configurable and really anything can be achieved https://hatch.pypa.io/latest/config/build/#file-selection (note that patterns for include/exclude are the same as Git so everyone will be familiar)

[tool.hatch.build.targets.wheel]
packages = ["xclim"]  # since there is no src directory the `include` option is equivalent here
exclude = ["xclim/testing"]

[tool.hatch.build.targets.sdist]
include = ["..."]

[lwasser]

perfect. thank you! it looks like this package is going to stick with flit BUT i'm going to add this info to our guide when we talk about tests and including / excluding things from the distributions. many many thanks for the speedy reply!!

[ofek]

Happy to help!