Specify location for force_include in custom build hook

[ReubenVandezande]

I'm working on a custom build hook which needs to generate and install a directory at the root of the python installation (my_directory).

- bin
- lib/python3.7/site-packages
- my_directory

So far I've been able to successfully generate the directory and include in the wheel, but it is installed in the site-packages folder:

- bin
- lib/python3.7/site-packages/my_directory

Is there a way to achieve the first example with a custom build hook? I currently have:

if version == "editable":  # no cov
    build_data["force_include_editable"][original_path] = wheel_path
else:
    build_data["force_include"][original_path] = wheel_path

[ReubenVandezande]

Using relative paths doesn't work (for good reason) and errors with the following:

ERROR: For req: XXX=0.0.0. 
The wheel '/tmp/pip-ephem-wheel-cache-A/XXX.whl' has a file 
'.../build/lib/python3.7/site-packages/../../../my_directory/my_file' 
trying to install outside the target directory 
'.../build/lib/python3.7/site-packages'

[ofek]

shared-data? https://hatch.pypa.io/latest/plugins/builder/wheel/#options

[ReubenVandezande]

Is that accessible from the BuildHook interface? I looked through the list of data that can be modified by build hooks and that isn't one.

[ReubenVandezande]

Looking into this I found a similar question here #528 (reply in thread).

I attempted a similar setup and ran into errors as well (expected a string, not a dictionary). Setting the value to a string seems to not error out, but the directory is not included in the wheel.

My attempts so far:

1. Installing without a shared-data key in the pyproject.toml file
2. Adding in an empty shared-data key to the pyproject.toml file

[tool.hatch.build.targets.wheel.shared-data]

3. Adding in a non-empty shared-data key to the pyproject.toml file

[tool.hatch.build.targets.wheel.shared-data]
tests = tests

In the third case, my tests were correctly included so I know that at least works.

[ofek]

I can add that option to build hook data if that would actually solve your use case

[ReubenVandezande]

That would certainly solve it.

The current solution requires installing at site-packages with force-include and manually linking the required folder to the top-level, so not ideal.