PyPI正式支持Markdown

終於

我今天激動地宣布，PyPI支持使用Markdown編寫項目描述了！這個特性是備受矚目的，我們做了大量的工作，終於實現了這個特性。是直接的支持，而不是把Markdown轉換為rST，或者是使用其他的Hack方式。

例如，這個示例項目使用了Markdown描述：

https://pypi.org/project/markdown-description-example/

這裡是這個項目的源代碼：

https://github.com/di/markdown-description-example

下面是為自己的項目添加Markdown描述的實現步驟：

有一個README.md

有一個README.md，並確保裡面包含Markdown內容。文件後綴不必是.md（.mkdn/.markdown），後綴是什麼都可以。只是你的setup.py確保會讀取它並將內容設置給long_description

在setup.py中設置一個新參數

PEP566添加了一個新的元數據欄位Description-Content-Type。為了給你的長描述添加內容類型，你需要把下面參數添加到setup.py中的setup函數調用中。

升級你的setuptools

為了支持上面添加的新的元數據，你需要升級你的setuptools版本到>=38.6.0。

當然你也必須確實是在使用setuptools進行打包，這意味著在你的setup.py中應該有這樣一樣引入語句：

構建發布源碼

這一步跟以前沒有區別

升級你的twine

同時你還要升級你的twine，需要版本>=1.11.0，否則設置的新的元數據不會被正確地發送給PyPI。

（--pre參數是需要的，因為目前我們需要這個參數來讓twine升級到預發布版本）

上傳你的發布版

這一步跟以前也一樣

在pypi.org上查看你的項目

只有pypi.org能夠正確地展示你的Markdown描述，以前的pypi.python.org只會將Markdown代碼作為純文本展示，不過別擔心，舊的網站很快就要下線了

致謝

感謝Marc Abramowitz完成了這個特性的初版，感謝Nick Coghlan和Daniel Holth指導我通過了PEP的認證和審核，感謝Tres  Seaver, Sumana Harihareswara,  Jason R. Coombs 審核、測試並發布了這個特性，感謝配合我完成這個特性的整個PyPI團隊，包括Nicole Harris, Ernest W. Durbin III 和 Donald Stufft。

英文原文：https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi

譯者：詩書塞外

喜歡這篇文章嗎？立刻分享出去讓更多人知道吧！