あしあと

まずは残していくことから

PyPIの登録にMarkdownが使えるようになった!

PyPIPythonサードパーティー用ライブラリ)に登録する際、マークダウンが対応したみたいです。
今までは、reStructuredTextしか対応していなかったので、マークダウンで書いてコンバートしたり、ドキュメントを見ながらreStructuredTextで書いていたりしていたのですが、今回からマークダウンでよいので、かなり嬉しい。

ちなみに、たまたま、このstackoverflowを見ていたら気づきました。

stackoverflow.com

そのうち、いろんな人が手順を書きそうですが、簡単にメモ。(2018-04-30時点)
以下がPEPでの規定なので、そちらを読む方が手堅いです。

www.python.org

必要な環境

  • setuptoolsのバージョンが 38.6.0 以上
    大抵の人が古いので、バージョンアップが必要です
  • twine のバージョンが1.11.0 以上
    自分は入ってなかったので、pip install twine でインストールしました。

上記の環境が揃ってないと、マークダウンで書いても反映されないので、ご注意ください。

マークダウンで記載する方法

要点は3つで、

  1. マークダウン(*.md)で書く(当たり前)
  2. setup.py の long_description_content_type に 'text/markdown' と指定する
  3. アップロードするときは、 twine upload dist/* コマンドでアップロードする
    (厳密には python setup.py sdist でアーカイブを作成する必要もあります)

実際にアップしたサンプル(ライブラリ)は以下です。
これはファイル名を暗号化する自分用の簡易なライブラリです。

github(setup.py)

github.com

pypi

pypi.org

最後に

ほぼ自分用のメモに近い形で書いたので、何か補足とか質問があればどうぞ。
気が向いたら、もう少しちゃんと清書します。