"src" layout result in a package named "src"

[buhtz]

I think I have an essential misunderstand with hatch. So I created a minimal example to illustrate it.

• The example do use a src layout.
• The name of the distribution package is "bar" (definied in pyproject.toml).
• The name of the import package is "foo" (definied??? by the folder name used inside src folder?)
• The name of the entry point (name I can use on the shell to run the application) is "foobar" (definied in pyproject.toml).

myrepo
├── pyproject.toml
└── src
    └── foo
        ├── __init__.py
        └── __main__.py

But this is not installed as import package foo. It is installed as src.

$ foobar
Traceback (most recent call last):
  File "/home/user/.local/bin/foobar", line 5, in <module>
    from foo.__main__ import main
ModuleNotFoundError: No module named 'foo'

$ python3 -c "import foo"
Traceback (most recent call last):
  File "<string>", line 1, in <module>
ModuleNotFoundError: No module named 'foo'

$ python3 -c "import bar"
Traceback (most recent call last):
  File "<string>", line 1, in <module>
ModuleNotFoundError: No module named 'bar'

$ python3 -c "import src"

The problem might be that the package is installed in /home/user/.local/lib/python3.11/site-packages/src/foo instead of /home/user/.local/lib/python3.11/site-packages/foo.

pyproject.toml

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

[project]
name = "bar"
version = "0.0.1"

[project.scripts]
foobar = "foo.__main__:main"

I also tried to add this two lines to pyproject.toml. But without success.

[tool.hatch.build]
include = ['src/foo']

[ofek]

https://hatch.pypa.io/latest/config/build/#packages

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

[buhtz]

Thanks this helps.
I do not understand the docu you linked to. It might depend on my lack of knowledge about Python Packaging basics. But it might come in the future. ;)

I added a hatch-minimal-example to my tutorial repository.
https://codeberg.org/buhtz/tech-demo-python-packaging/src/branch/main/01b_terminal_helloworld_hatch

[fhg-isi]

In a case where you don't use project sub folders in src, in addition to the packages property

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

following might be helpful, too:

[tool.hatch.build.targets.wheel.sources]
"src" = "my_project"

However, that would only work if the project does not import dependencies from itself.

from foo import baa # does work locally but not once the project has been installed as package.

vs.

from my_project_name.foo import baa

[buhtz]

I don't understand. What is a "project sub folder" in Python terminology? "following" might help?
There is always a sub-folder (representing the "Python Import Package") in a "src" folder. The src-folder never contain a py file or something else then another folder. Otherwise it would violate the src-layout.
Please provide a full example to illustrate your approach.

[fhg-isi]

You are right. I did not understand the official definition of the "src-layout" correctly and I hoped I could get rid of the extra (somehow redundant) folder. However, this causes other issues.

my_project
+ src
++ my_project
+++ main.py
+ test
++ my_project
+++ test_main.py

vs.

my_project
+ src
++ main.py
+ test
++ test_main.py