自作パッケージをインストールする

Pythonパッケージ開発

James Fulton

Climate informatics researcher

なぜ自作パッケージをインストールするのか

example_script.py 内

import mysklearn

サブパッケージを含むディレクトリツリー

home/
|-- mysklearn            <-- 同じディレクトリにある
|  |-- __init__.py
|  |-- preprocessing
|  |   |-- __init__.py
|  |   |-- normalize.py
|  |   |-- standardize.py
|  |-- regression
|  |   |-- __init__.py
|  |   |-- regression.py
|  `-- utils.py
|-- example_script.py    <-- 同じディレクトリにある

なぜ自作パッケージをインストールするのか

example_script.py 内

import mysklearn

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'mysklearn'

ディレクトリツリー

home/
|-- mypackages
|   |-- mysklearn     <---
|       |-- __init__.py
|       |-- preprocessing
|       |   |-- __init__.py
|       |   |-- normalize.py
|       |   |-- standardize.py
|       |-- regression
|           |-- __init__.py
|           |-- regression.py
`-- myscripts
    `-- example_script.py     <---

setup.py

パッケージのインストールに使用
パッケージのメタデータを保持

パッケージのディレクトリ構成

サブパッケージを含むディレクトリツリー


    mysklearn/
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

パッケージのディレクトリ構成

サブパッケージを含むディレクトリツリー

mysklearn/      <-- 外側のディレクトリ
|-- mysklearn   <--- 内側のソースコード用ディレクトリ
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

パッケージのディレクトリ構成

サブパッケージを含むディレクトリツリー

mysklearn/      <-- 外側のディレクトリ
|-- mysklearn   <--- 内側のソースコード用ディレクトリ
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py   <-- 外側にあるセットアップスクリプト

setup.py の中身

# Import required functions
from setuptools import setup


# Call setup function
setup(

    author="James Fulton",

    description="A complete package for linear regression.",

    name="mysklearn",

    version="0.1.0",

)

バージョン番号 = (メジャー).(マイナー).(パッチ)

setup.py の中身

# Import required functions
from setuptools import setup, find_packages

# Call setup function
setup(
    author="James Fulton",
    description="A complete package for linear regression.",
    name="mysklearn",
    version="0.1.0",

    packages=find_packages(include=["mysklearn", "mysklearn.*"]),

)

編集可能インストール

pip install -e .

. = 現在のディレクトリ内のパッケージ
-e = 編集可能（editable）

サブパッケージを含むディレクトリツリー

mysklearn/  <-- ここに移動
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py

Passons à la pratique !

Pythonパッケージ開発