How to create a project with namespace package?

[Solvero]

Hello. I would like to kindly ask You how to create a namespace/package. I have tried different combinations:

hatch new namespace/name
hatch new name namespace
hatch new namespace/name namespace-name

But it doesn't create valid namespace.
I've also tried to do manual changes in pyproject.toml and folder structure without success.

I expect to have similar structure:

project/
    pyproject.toml
    src
      namespace
          some-package
             __init__.py

After hatch build and pip install my-package.tar.gz I should be able to import:

from namespace import some-package

[ofek]

There is no option to generate a namespace package, but after you manually create the directory structure you would ship it with this option https://hatch.pypa.io/latest/config/build/#packages

[12rambau]

I don't understand how this is a solution for this problem. In the documentation it's written:

The packages option is semantically equivalent to only-include (which takes precedence) except that the shipped path will be collapsed to only include the final component.

which means the package will become reachable via:

import some-package

I'm working on updating packaging of the sphinx-contrib extensions and they all live in the sphinxcontrib namespace. It needs to be preserved to avoid breaking all the existing doc builds.

[ofek]

You can ship anything, what is not supported is the generation of namespace packages via the hatch new command.

What is your current issue?

[12rambau]

I was simply misunderstanding the documentation, I did what you suggested in the meantime, and even though I don't understand exactly why, it worked ;-)

[tartopohm]

Adding a little complement, as it wasn't entirely clear to me.
For a structure

namespace-package/
├─ pyproject.toml
├─ src/
├── namespace/
├─── package/
├──── __init__.py
├──── module.py

having

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

in pyproject.toml allows for

import namespace
import namespace.package
import namespace.package.module

after installing the package.

[krishvira-erb]

It can also be done by being explicit about the package being distributed, for example, by having the following in pyproject.toml:

[tool.hatch.build.targets.wheel]
sources = ["src"]
only-include = ["src/namespace/package"]