Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flying-sheep/hatch-docstring-description

Derive PyPI package description from Python package docstring
https://github.com/flying-sheep/hatch-docstring-description

Last synced: about 1 month ago
JSON representation

Derive PyPI package description from Python package docstring

Host: GitHub
URL: https://github.com/flying-sheep/hatch-docstring-description
Owner: flying-sheep
License: gpl-3.0
Created: 2023-06-26T08:18:34.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-11-04T11:26:31.000Z (about 2 months ago)
Last Synced: 2024-11-04T12:19:14.087Z (about 2 months ago)
Language: Python
Homepage:
Size: 84 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.rst
- License: LICENSE.md

Awesome Lists containing this project

README

        hatch-docstring-description

===========================

|PyPI Version| |PyPI Python Version| |Coverage|

Usage

-----

#. Include it as a plugin to your ``pyproject.toml``:

   .. code:: toml

      [build-system]

      requires = ["hatchling", "hatch-docstring-description"]

      build-backend = "hatchling.build"

#. Mark your ``description`` field as ``dynamic``:

   .. code:: toml

      [project]

      dynamic = ["description"]

#. And make sure Hatchling uses it:

   .. code:: toml

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

License

-------

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

.. |PyPI Version| image:: https://img.shields.io/pypi/v/hatch-docstring-description.svg

   :target: https://pypi.org/project/hatch-docstring-description

.. |PyPI Python Version| image:: https://img.shields.io/pypi/pyversions/hatch-docstring-description.svg

   :target: https://pypi.org/project/hatch-docstring-description

.. |Coverage| image:: https://codecov.io/github/flying-sheep/hatch-docstring-description/branch/main/graph/badge.svg?token=FZCw1cXSTL

   :target: https://codecov.io/github/flying-sheep/hatch-docstring-description

.. _GPL 3 (or later): https://spdx.org/licenses/GPL-3.0-or-later.html