Pythonで自作のライブラリをパッケージ化する方法について説明します。この記事は、Pythonのソースコードを他の環境に持って行って実行するためのパッケージ化の手順を説明します。
パッケージとは
Pythonのライブラリとしては「モジュール」と「パッケージ」の2つの概念があります。モジュールは.pyファイルのことで、関数やクラスの集まりを指します。一方、パッケージは複数のモジュールを1つのディレクトリにまとめたもので、基本的に関連する機能(モジュール)をまとめておくものです。
パッケージ化の手順
- setup.pyを作成する: setuptoolsモジュールで提供されるsetup()関数を用いて、Wheel形式のパッケージを作成します。setup.pyは、たとえば次のように記述します。
import setuptools
with open('requirements.txt') as f:
requirements = f.read().splitlines()
setuptools.setup(
name="your_package_name",
version="0.0.1",
install_requires=requirements,
packages=setuptools.find_packages(),
)
-
init.pyファイルを作成する: init.pyは、モジュール検索用のマーカで、パッケージ内のモジュールを正しく認識させるものです。
-
各クラスファイルを作成する: 作成したパッケージが提供する機能としては、例えば動物の鳴き声を返す機能などが考えられます。
-
作成したパッケージをPythonにインストールする: パッケージと同じディレクトリ階層で
pip install .
を実行します。 -
パッケージがインストールできたか確認する:
pip list
でインストール済みのライブラリを確認します。
以上がPythonで自作のライブラリをパッケージ化する基本的な手順です。これにより、自作のライブラリを他のPythonプロジェクトで簡単に再利用することが可能になります。