Skip to main content

A hatchling plugin to read the description from the package docstring

Project description

PyPI Version PyPI Python Version Coverage

A hatchling plugin to read the description from the package docstring like flit does.

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"]
  3. And make sure Hatchling uses it:

    [tool.hatch.metadata.hooks.docstring-description]

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hatch_docstring_description-1.1.1.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hatch_docstring_description-1.1.1-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file hatch_docstring_description-1.1.1.tar.gz.

File metadata

File hashes

Hashes for hatch_docstring_description-1.1.1.tar.gz
Algorithm Hash digest
SHA256 b15d93c273ba3736abc9e2c542bb42a728a6740703ff5ed85cc072ed49458ae3
MD5 13c5aab10e47f2a209e8ae85aa719d67
BLAKE2b-256 5aa6d2cd9d4bd9d58540825b5eb5eafaf0ede14bc3a66cc406501bbadd442e0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for hatch_docstring_description-1.1.1.tar.gz:

Publisher: pub.yml on flying-sheep/hatch-docstring-description

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hatch_docstring_description-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for hatch_docstring_description-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 35aea8903161b8758cda903b2aa797ecaa403137cd5439f0b0b64348e002bb29
MD5 c749a87e311d38b0de69142371c7511d
BLAKE2b-256 85247dd2ede7d6980932ac652aa6156a09b90776d0efb3d76cb720ba592d6e28

See more details on using hashes here.

Provenance

The following attestation bundles were made for hatch_docstring_description-1.1.1-py3-none-any.whl:

Publisher: pub.yml on flying-sheep/hatch-docstring-description

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page