Python 自作パッケージ 作成からインストールまで

はじめに

この記事は、社会人２年目 AWS、python初心者が勉強したことをまとめたものです。
間違っている点、改善点等ございましたご指摘いただけると大変ありがたいです。

この記事について

自身の備忘録です。
Pythonで自作パッケージを作成してインストールするまでの手順を記します。

作成

ディレクトリ構成

.
├── sushi_library
│   ├── __init__.py # パッケージimport時最初に呼び出される。
│   └── base.py
├── setup.py # パッケージ作成に必須のファイル

必要モジュール

setup.py

setup.py

from setuptools import setup, find_packages

setup(
    name = 'sushi_library', # パッケージ名
    version='0.0.1', # バージョン
    description='Package for data analysis', # パッケージの説明
    author='Sushi Master', # 作成者
    author_email='[e-mail]', # 作成者のメールアドレス
    install_requires=['numpy', 'pandas', 'pymysql'], # 依存ライブラリ
    packages = find_packages(),
)

__init__.py

from base import *

sushi_libraryがimport されると__init__.pyが最初に読み込まれます。
__init__.pyは無くてもパッケージの作成は可能です。

ではなぜ__init__.pyを作成しておくかというとサブモジュールの名前をインポートするときに少し楽になるからです。

__init__.pyがない場合、サブモジュールbase.pyのdb_connection関数をインポートするには
import sushi_library.base.db_connectionを実行することとなる。

上の__init__.pyが存在する場合、
import sushi_library.db_connectionを実行すればよく、サブモジュール名を省略することができるようになります。

インストール

パッケージ一式が存在するディレクトリに移動し下記コマンドを実行するとインストールされます。

pip install -e .

インストール後はどのディレクトリからもパッケージを呼び出すことができます。