Python コードの共有の基本

はじめに

ある時点で、おそらく同僚だけでも、誰かにコードを渡したい場合があります。このセクションでは、その最も基本的な手法について説明します。より詳細な情報については、Python Packaging User Guide を参照する必要があります。

setup.py ファイルの作成

プロジェクトディレクトリのトップレベルに、/home/labex/project ディレクトリに setup.py ファイルを追加します。

## setup.py
import setuptools

setuptools.setup(
    name="porty",
    version="0.0.1",
    author="Your Name",
    author_email="you@example.com",
    description="Practical Python Code",
    packages=setuptools.find_packages(),
)

MANIFEST.in の作成

プロジェクトに関連付けられている追加のファイルがある場合は、MANIFEST.in ファイルで指定します。たとえば：

## MANIFEST.in
include *.csv

MANIFEST.in ファイルを setup.py と同じディレクトリに置きます。

ソース配布物の作成

コードの配布物を作成するには、setup.py ファイルを使用します。たとえば：

$ python setup.py sdist

これにより、dist/ ディレクトリに .tar.gz または .zip ファイルが作成されます。そのファイルは、これから他の人に渡すことができるものです。

コードのインストール

他の人は、他のパッケージと同じ方法で pip を使ってあなたの Python コードをインストールできます。彼らは、前のステップで作成したファイルを提供するだけです。たとえば：

$ python -m pip install porty-0.0.1.tar.gz

解説

上記の手順は、他の人に渡すことができる Python コードのパッケージを作成する最も基本的なことを説明しています。実際には、第三者の依存関係や、アプリケーションに外部コード（すなわち、C/C++）が含まれているかどうかなどによって、はるかに複雑になる場合があります。それらについては、このコースの範囲外です。私たちは、わずかな最初の一歩を踏み出しただけです。

演習 9.5：パッケージの作成

演習 9.3 で作成した porty-app/ コードを使って、ここで説明した手順を再現できるかどうか確認してみましょう。具体的には、トップレベルのディレクトリに setup.py ファイルと MANIFEST.in ファイルを追加します。python setup.py sdist を実行してソース配布ファイルを作成します。

最後のステップとして、作成したパッケージを Python 仮想環境にインストールできるかどうか確認してみましょう。

まとめ

おめでとうございます！あなたは配布実験を完了しました。あなたのスキルを向上させるために、LabEx でさらに多くの実験を練習できます。