hatch-project-name 1.0.0a5

Hatch build hook plugin that writes the project name to a file

hatch-project-name

CI/CD
Package
Meta

---

This provides a build hook plugin for Hatch that writes the project name defined in pyproject.toml to a file.

Table of Contents

• Rationale
• Configuration
  • Build hook options
  • Editable installs
• License

Rationale

TODO

Configuration

The build hook plugin name is project-name.

• pyproject.toml

  [project]
  name = "my-package"
  
  [tool.hatch.build.hooks.project-name]
  dependencies = ["hatch-project-name"]
  name-file = "src/my_package/_name.py"
  

• hatch.toml

  [project]
  name = "my-package"
  
  [build.hooks.project-name]
  dependencies = ["hatch-project-name"]
  name-file = "src/my_package/_name.py"
  

Building the project will generate the file

• _name.py

  project_name = __project_name__ = distribution_name = __distribution_name__ = "my-package"
  

Build hook options

Option	Type	Default	Description
name-file	str	REQUIRED	The relative path to the file that gets updated with the project name.

Editable installs

The name file is only updated upon install or build. Thus the name in an editable install (Hatch's dev mode) will be incorrect if the name is changed in pyproject.toml and the project is not rebuilt.

License

hatch-project-name is distributed under the terms of the MIT license.