- pipとは何か
- pipの裏側でやっていること
- 自作のライブラリをpipでインストールする方法
pipとは
pipとは、
です。
pythonで外部ライブラリを使いたい場合にはpipコマンドを使ってインストールするのが一般的な方法です。
pipコマンドを使ったインストールは
pip install library-nameのように行います。
※library-nameには任意のライブラリ名が入ります。
pipはpythonのバージョンごとにインストールされるので、
python3.6 -m pip library-namepython2.7 -m pip library-nameといったコマンドで使用することも可能です。
ちなみに、pip は「 Pip Installs Python」 または「 Pip Installs Packages」 を略したものだとされています。
pipコマンドの使い方だけ知りたい人は、こちらの記事をご覧ください。
pipの裏側では何をやっているのか
pipでライブラリのインストールを簡単に行うことができますが、裏側では何が行われているのか見てみましょう。
「pip install library-name」コマンドを実行すると以下のような処理が行われます。
- ステップ1PyPIリポジトリに接続する
- ステップ2「library-name」という名前のライブラリを検索する
- ステップ3pythonの環境に適したバージョンのlibrary-nameライブラリをダウンロードする
- ステップ4site-packagesディレクトリにlibrary-nameをインストールする
PiPYリポジトリとは「Python Package Index」の略で、python標準のパッケージ管理システムです。
pythonユーザの先人たちが作ったパッケージが登録してあり、誰でも利用することができるようになっています。
PiPYで管理されているパッケージはGoogleやMicrosoftなどのスーパーエンジニアしか登録できないわけではなく、誰でも登録することができます。
自作のライブラリをpipでインストールする
先程pipではPyPIリポジトリに接続すると説明したのですが、実はローカルのファイルや自分のgithubに接続することもできます。
自作ライブラリをpipでインストールするためには、setup.pyさえ作ればOKです。
ローカルのファイルをpipでインストール
早速ローカルに作成したプログラムをpipでインストールできるようにしてみましょう。
フォルダ構成は以下のようになります。
├ setup.py ├ my_package # 自作のパッケージ ├ __init__.py ├ tools.py # メインのプログラム
setup.pyを作成して、パッケージの情報を設定します。
最小の構成にするとこのようなファイルになります。
from setuptools import setup, find_packages
setup(
name="my_package",
version='0.1',
packages=find_packages()
)
def hello():
print("hello pip")
では、いよいよpipでインストールしてみましょう。
setup.pyと同じディレクトリに移動して以下のpipコマンドを打ちます。
pip install .
Successfully installed my-package-0.1と表示されたら成功です。
pip listコマンドで確認してみましょう。
pip list | grep my-packagemy-package 0.1が見つかり、インストールができています。
アンインストールする場合も普段のpipコマンドと同様に
pip uninstall my-packageで削除できます。
インストールしたライブラリを使ってみる
先程インストールしたmy-packageを使ってみましょう。
from my_package import tools
tools.hello()を実行すると、
hello pipと表示されました。
ちなみに、__init__.pyに使いたいモジュールを定義しておけば、モジュール名を省略して使うことができます。
from my_package.tools import *pipでインストールし直して、
import my_package
my_package.hello()を実行すると、
hello pipと表示されました。
gitにある自作ライブラリをpipでインストールする
ローカルのファイルをpipでインストールできたら、次はgitから直接インストールしてみましょう。
今まで作ったファイルを同じディレクトリ構成でgithubにアップロードします。
それだけでもう準備完了です。
pip install git+<リポジトリのURL>をするとインストールすることができます。
pip install git+https://github.com/xxxxx/my_package
まとめ
pipとは、Python のパッケージをインストールするためのパッケージ マネージャーです。
デフォルトではPiPYリポジトリに接続されますが、ローカル環境や個人のgitにあるソースコードを指定してインストールすることもできます。
setup.pyさえ作っておけばpipコマンドで簡単に自分のライブラリを使うことができるので、ぜひ使い方を覚えておきましょう。
参考文献
コメント