How can I programmatically get the project name within my hatch project?

[kannangce]

My pyproject.toml has the below configuration,

[project]
name = "my-awesome-project"

How can I programatically get the project name within my code without reading the pyproject.toml myself?

Details:

• I'm using hatch 1.14.0 with python 3.12.10

[valentinoli]

This relates more generally to the distinction between a module and a distribution.

You might be able to map one of the top level package names to the project/distribution name with importlib. Say one top level package name in the project is "my_tool". Then you can do:

from importlib import metadata

def get_project_name() -> str:
    pkg_name = "my_tool"
    pkg_to_dists = metadata.packages_distributions()
    return pkg_to_dists[pkg_name][0]

This would not work for namespace packages though as the top level namespace will map to potentially multiple distributions.

Also note that this might not work with an editable install. See below docs:

https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.packages_distributions

[ofek]

hatch project metadata name

[kannangce]

This relates more generally to the distinction between a module and a distribution.

You might be able to map one of the top level package names to the project/distribution name with importlib. Say one top level package name in the project is "my_tool". Then you can do:

from importlib import metadata

def get_project_name() -> str:
pkg_name = "my_tool"
pkg_to_dists = metadata.packages_distributions()
return pkg_to_dists[pkg_name][0]
This would not work for namespace packages though as the top level namespace will map to potentially multiple distributions.

Also note that this might not work with an editable install. See below docs:

https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.packages_distributions

Thanks a lot @valentinoli! But that works only for the installed packages. metadata.packages_distributions doesn't contain my current project.

[kannangce]

hatch project metadata name

Hi @ofek ,

Thanks for the response. But that was not helpful(sorrry!).

My question was on ..within my code ...

[ofek]

If the project is not already installed then you need to run through the whole process of build environment creation and running the hooks. The easiest way, with Hatch, is to call it via a subprocess. Otherwise you have to use something else like https://github.com/pypa/build

[kannangce]

If the project is not already installed then you need to run through the whole process of build environment creation and running the hooks. The easiest way, with Hatch, is to call it via a subprocess. Otherwise you have to use something else like https://github.com/pypa/build

Hmm. That might not be an elegant way.
I would probably hardcode it for now!

[valentinoli]

@kannangce
@ofek

To address this issue I published a new build hook named hatch-project-name.

https://github.com/valentinoli/hatch-project-name
https://pypi.org/project/hatch-project-name/