[PYTHON] Erzeugt halbautomatisch eine Beschreibung des Pakets, das in PyPI registriert werden soll
Überblick
Bei der Registrierung eines Pakets in PyPI wird README.md als beschreibender Text verwendet, sofern nicht anders angegeben. Da es jedoch nicht im Markdown-Format gerendert wird, werden hässliche Sätze wie unten gezeigt angezeigt.
Diese Beschreibung wird im reStructuredText-Format gerendert. Daher wird die Methode zum Generieren von README.rst aus README.md und zum Festlegen als beschreibenden Text als Memorandum beschrieben.
Konvertieren Sie von Markdown zu reStructuredText
Wenn Sie die Codebasis mit GitHub usw. verwalten, gilt README.md als vorbereitet Konvertieren Sie diesen Markdown-Text in das Format reStructuredText.
Verwenden Sie Pandoc für die Konvertierung.
$ pandoc --from markdown --to rst README.md -o README.rst
Pandoc kann mit Brew installiert werden.
$ brew install pandoc
Registrierung in Paketinformationen
Wenn sowohl README.md als auch README.rst im Paket enthalten sind Da README.md Priorität hat, richten Sie README.rst so ein, dass es als beschreibender Text in setup.py verwendet wird.
Übergeben Sie insbesondere den Inhalt von README.rst an das Schlüsselwortargument long_description der Funktion setup.
setup.py
from os import path
from setuptools import setup, find_packages
def read(fname):
return open(path.join(path.dirname(__file__), fname)).read()
setup(
long_description=read("README.rst"),
... #Andere Elemente weggelassen
)
Wenn Sie das Paket wie oben beschrieben registrieren, wird es wie unten gezeigt sicher gerendert.
Recommended Posts