Using dev mode when project name != package name

[aazuspan]

I have a project where the installed project name foo is different than the imported package name bar, and I'm having trouble getting hatch to find it in dev mode. I found the file selection options, but adding bar and src/bar to the include and/or packages options didn't seem to resolve the issue. The only solution I did find was to rename the project to bar.

To reproduce, you can run hatch new foo, rename src/foo to src/bar (and update the tool.hatch.version.path), then test with:

$ hatch run python -c "import bar"

ModuleNotFoundError: No module named 'bar'

Maybe there's something I'm missing about how hatch shell and hatch run build the editable package that prevents this from working? Any tips would be appreciated!

[ofek]

Please paste your configuration

[aazuspan]

Sure, here is the reproducible demo pyproject.toml, which is just a stripped down version of the default with the added tool.hatch.build options.

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "foo"
dynamic = ["version"]
description = ''
readme = "README.md"
requires-python = ">=3.10"
license = "MIT"
keywords = []
authors = [
  { name = "Aaron Zuspan", email = "aa.zuspan@gmail.com" },
]
classifiers = [
  "Development Status :: 4 - Beta",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = []

[tool.hatch.version]
path = "src/bar/__about__.py"

[tool.hatch.build]
include = ["src/bar"]
packages = ["bar"]

And the folder structure:

├── src/
│   └── bar/
│       ├── __about__.py
│       └── __init__.py
├── pyproject.toml
├── README.md
└── LICENSE.txt

[ofek]

Get rid of [tool.hatch.build] and instead do:

[tool.hatch.build.targets.wheel]
packages = ["src/bar"]

[aazuspan]

Aha, I had to run hatch env prune and rebuild the environment for that change to take effect, but it works now.

Thanks for such a quick solution!

[ofek]

Happy to help!

[tombola]

Thanks @ofek, that helped me too

[seakros]

@ofek Just for the sake of understanding, the problem was that what they originally had was functionally equivalent to:

[tool.hatch.build]
include = ["src/bar"]
only-include = ["bar"]  # <-- annuls the previous line and is wrongly searching for a folder at root called "bar" that doesn't exist
sources = ""

correct?

However, why the switch of the entry to [tool.hatch.build.targets.wheel]? Would:

[tool.hatch.build]
packages = ["src/bar"]

also have been correct? What's the advantage of specifying target.wheel?