[PYTHON] Générer semi-automatiquement une description du package à enregistrer dans PyPI
Aperçu
Lors de l'enregistrement d'un package dans PyPI, README.md est utilisé comme texte descriptif, sauf indication contraire. Cependant, comme il n'est pas rendu au format Markdown, les phrases laides seront affichées comme indiqué ci-dessous.
Cette description est rendue au format reStructuredText. Par conséquent, la méthode de génération de README.rst à partir de README.md et de le définir comme un texte descriptif est décrite comme un mémorandum.
Convertir de Markdown en reStructuredText
Si vous gérez la base de code avec GitHub etc., README.md est considéré comme préparé, donc Convertissez ce texte Markdown au format reStructuredText.
Utilisez Pandoc pour la conversion.
$ pandoc --from markdown --to rst README.md -o README.rst
Pandoc peut être installé avec une infusion.
$ brew install pandoc
Inscription dans les informations du package
Si README.md et README.rst sont inclus dans le package Puisque README.md a la priorité, configurez README.rst pour qu'il soit utilisé comme texte descriptif dans setup.py.
Plus précisément, passez le contenu de README.rst à l'argument mot-clé long_description de la fonction 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"),
... #Autres éléments omis
)
Si vous enregistrez le package par la procédure ci-dessus, il sera rendu en toute sécurité comme indiqué ci-dessous.
Recommended Posts