How to manage a README for both github and 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

How to manage a README for both github and PyPI
How to write a metaclass that supports both python2 and python3
[For beginners] How to register a library created in Python in PyPI
How to create a clone from Github
How to split and save a DataFrame
How to write a ShellScript Bash for statement
How to create a shortcut command for LINUX
How to read PyPI
[Go] How to create a custom error for Sentry
How to create a local repository for Linux OS
How to build a development environment for TensorFlow (1.0.0) (Mac)
Python # How to check type and type for super beginners
How to use GitHub on a multi-person server without a password
How to set up WSL2 on Windows 10 and create a study environment for Linux commands
How to call a function
How to register on pypi
How to define multiple variables in a python for statement
How to learn TensorFlow for liberal arts and Python beginners
How to make a Python package (written for an intern)
How to substitute a numerical value for a partial match (Note 1)
How to write a test for processing that uses BigQuery
How to hack a terminal
How to register a package on PyPI (as of September 2017)
How to create a SAS token for Azure IoT Hub
How to set a shortcut to switch full-width and half-width with IBus
How to build a LAMP environment using Vagrant and VirtulBox Note
PyPI registration steps for those who want to make a PyPI debut
Overview of how to create a server socket and how to establish a client socket
How to compare lists and retrieve common elements in a list
[Python] How to add rows and columns to a table (pandas DataFrame)
How to make a surveillance camera (Security Camera) with Opencv and Python
How to use Serverless Framework & Python environment variables and manage stages
How to create a label (mask) for segmentation with labelme (semantic segmentation mask)
[Introduction to Python] How to use the in operator in a for statement?
JOI2019 / 2020 1st qualifying 3rd How to solve problems A and B
[C language] How to create, avoid, and make a zombie process
Spigot (Paper) Introduction to how to make a plug-in for 2020 # 01 (Environment construction)
How to block ads for free on iPhone and iPad apps
How to format a table using Pandas apply, pivot and swaplevel
How to make a unit test Part.1 Design pattern for introduction
How to make a Japanese-English translation
How to write a Python class
How to put a symbolic link
[For non-programmers] How to walk Kaggle
How to install and use Tesseract-OCR
How to make a slack bot
How to create a Conda package
How to make a crawler --Advanced
How to make a recursive function
How to create a virtual bridge
How to install and configure blackbird
How to use .bash_profile and .bashrc
How to install CUDA and nvidia-driver
How to install and use Graphviz
How to make a deadman's switch
How to create a Dockerfile (basic)
[Blender] How to make a Blender plugin
How to delete a Docker container
How to make a crawler --Basic
How to create a config file
How to solve slide puzzles and 15 puzzles