/hatch-docstring-description

Derive PyPI package description from Python package docstring

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

hatch-docstring-description

PyPI Version PyPI Python Version Coverage

Usage

  1. Include it as a plugin to your pyproject.toml:

    [build-system]
requires = ["hatchling", "hatch-docstring-description"]
build-backend = "hatchling.build"

  2. Mark your description field as dynamic:

    [project]
dynamic = ["description"]

License

hatch-docstring-description is distributed under the terms of the GPL 3 (or later) license.