Zenn
😑

Python初心者が学んだ「setup.py」と「README.md」の役割まとめ【自作パッケージ公開の第一歩】

に公開
Python
プログラミング
tech

Python学習中に、自作パッケージを作ってみたくなったので、
setup.py や README.md について調べながら実際に書いてみました。
テンプレを学んだという感じです。
同じように学んでる方の参考になれば嬉しいです！

setup.pyってなに？

一言でいうと「パッケージの中身を機械に教えるための設定ファイル」です。

これがあることで、以下のことができるようになります👇

  • pipで自作パッケージをインストールできる
  • PyPIに公開できる
  • 他の人にも簡単に使ってもらえる

中身の例

from setuptools import setup, find_packages

setup(
    name='python_programming',
    version='1.0.0',
    packages=find_packages(),
    author='kdoi',
    description='Python入門の練習用パッケージ',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
)

README.md　＝「人間に向けた説明書」

GitHubのプロジェクトページやPyPIに表示される内容。
よく書くこと
＊このパッケージで何ができるか
＊インストール方法
＊使用例（コードつき）
＊ライセンス

学んだこと＆これから
今回は初めて自分で setup.py と README.md を書いて、
パッケージを pip install でインストールできるところまでできました！
次は依存パッケージや、PyPIへの公開にも挑戦してみたいと思ってます💪

アドバイス等いただければ嬉しいです！！！！

Discussion