Comment gérer un README pour github et PyPI

First of all, write a README in either Markdown (.md) or ReStructuredText (.rst). Next, convert the README to the other one with pandoc.

pandoc -f markdown -t rst README.md > README

or

pandoc -f rst -t markdown README > README.md

Note that PyPI requires not README.rst but README.

For PyPI, you need to set the README content to long_description in setup.py:

setup(
    ...
    long_description=open('README').read(),
    ...

Then, your PyPI page looks same as github page.

Recommended Posts

Comment gérer un README pour github et PyPI
Comment écrire une classe méta qui prend en charge à la fois python2 et python3
Comment créer un clone depuis Github
Comment diviser et enregistrer un DataFrame
Comment écrire une instruction ShellScript Bash for
Comment lire PyPI
[Go] Comment créer une erreur personnalisée pour Sentry
Comment créer un référentiel local pour le système d'exploitation Linux
Comment créer un environnement de développement pour TensorFlow (1.0.0) (Mac)
Python # Comment vérifier le type et le type pour les super débutants
Comment utiliser GitHub sur un serveur multi-personnes sans mot de passe
Comment configurer WSL2 sur Windows 10 et créer un environnement d'étude pour les commandes Linux
Comment appeler une fonction
Comment s'inscrire auprès de pypi
Comment définir plusieurs variables dans une instruction Python for
Méthode d'apprentissage TensorFlow pour les professionnels des arts libéraux et les débutants en Python
Comment créer un package Python (écrit pour un stagiaire)
Comment remplacer une valeur numérique pour une correspondance partielle (Remarque 1)
Comment rédiger un test de traitement utilisant BigQuery
Comment pirater un terminal
Comment enregistrer un package dans PyPI (à partir de septembre 2017)
Comment définir un raccourci pour basculer entre pleine largeur et demi-largeur dans IBus
Remarques sur la création d'un environnement LAMP à l'aide de Vagrant et VirtulBox
Procédure d'inscription PyPI pour ceux qui veulent faire leurs débuts PyPI
Présentation de la création d'un socket serveur et de la création d'un socket client
Comment comparer des listes et récupérer des éléments communs dans une liste
[Python] Comment ajouter des lignes et des colonnes à une table (pandas DataFrame)
Comment créer une caméra de surveillance (caméra de sécurité) avec Opencv et Python
Comment utiliser les variables d'environnement Serverless Framework et Python et gérer les étapes
Comment créer une étiquette (masque) pour la segmentation avec labelme (masque de segmentation sémantique)
[Introduction à Python] Comment utiliser l'opérateur in dans l'instruction for?
JOI2019 / 2020 1ère qualification 3ème Comment résoudre les problèmes A et B
[Langage C] Comment créer, éviter et créer un processus zombie
Spigot (Paper) Introduction à la création d'un plug-in pour 2020 # 01 (Construction de l'environnement)
Comment bloquer les publicités gratuitement sur les applications iPhone et iPad
Comment formater un tableau à l'aide de Pandas Appliquer, pivoter et permuter le niveau
Comment faire un test unitaire Part.1 Modèle de conception pour l'introduction
Comment faire une traduction japonais-anglais
Comment mettre un lien symbolique
[Pour les non-programmeurs] Comment marcher Kaggle
Comment installer et utiliser Tesseract-OCR
Comment créer un bot slack
Comment créer un package Conda
Comment créer un robot - Avancé
Comment créer une fonction récursive
Comment créer un pont virtuel
Comment installer et configurer Blackbird
Comment utiliser .bash_profile et .bashrc
Comment installer et utiliser Graphviz
Comment créer un Dockerfile (basique)
[Blender] Comment créer un plug-in Blender
Comment supprimer un conteneur Docker
Comment créer un robot - Basic
Comment créer un fichier de configuration
Résoudre des puzzles et 15 puzzles