インストール

South の最新リリースは 0.7 です。

South をインストールするにはいくつかの方法があります:

いくつかの Linux ディストリビューションでは South がパッケージリポジトリに登録され始めました; unstable な Debian なら apt-get install python-django-south を、最新の Fedoraならば yum install Django-south としてインストールできます。 これらは古いバージョンがインストールされるかもしれないことに注意して下さい - パッケージを利用する前にバージョンをご確認下さい。

South は Django の 0.97-pre から 1.2 までのバージョンで動作しますが、いくつかの機能(マルチDBなど)は古いバージョンの Django ではご利用できません。

easy_install を使う

システムに easy_install が入っているならば、以下のようにタイプするだけです:

easy_install South

もし既に古いバージョンの South をインストールしていて、アップグレードしたい場合は:

easy_install -U South

これでパッケージのインストールは完了です; 次は Django へのインストール設定 に進んで下さい。

Mercurial を使う

アップデートやバグフィックスがすぐに反映されて取得可能な、Mercurial のリポジトリから直接インストールすることもできます。 システムに Mercurial がインストールされている必要があります; まだ Mercurial が入っていない場合は、インストールしましょう。 大抵の Linux ディストリビューションにおけるパッケージ名は mercurial です; OSX や Windows ユーザーならば、 http://mercurial.berkwood.com からパッケージをダウンロードすることができます。

south ディレクトリが出来て欲しいディレクトリにいることを確認し、次のコマンドを実行して下さい:

hg clone http://bitbucket.org/andrewgodwin/south/

Mercurial でチェックアウトしている既存のファイルを最新版にアップデートしたい場合は、次のコマンドを実行します:

hg pull
hg up -C tip

(最新版である tip に更新するよりも、安定版の trunk コミットとして設定されている stableishi タグや、 バージョン番号タグを指定するほうがいいかもしれません)

south ディレクトリが取得できたので ディレクトリからのインストール に進みましょう。

アーカイブをダウンロードする

Mercurial を使用したくない場合や、easy_install がインストールされていない場合などには、 .tar.gz ファイルからインストールすることができます。

まず、 South の リリースページ からアーカイブをダウンロードして、 south フォルダができるように解凍します。次に ディレクトリからのインストール の説明に進んで下さい。

ディレクトリからのインストール

Mercurial を使ったり、アーカイブをダウンロードして South のコピーを取得した場合、 システム全体で利用できるように、そのコピーからインストールする必要があります。 次のコマンドを実行して下さい:

python setup.py develop

もしこのコマンドが失敗した場合は、 setuptools かそれと同等のモジュールが インストールされていないので、それらをインストールするか、次のコマンドを実行して下さい:

python setup.py install

develop はインストールされたバージョンを作成したディレクトリから起動するように設定しますが、 install は全てのファイルを Python の site-packages フォルダにコピーする、という点に注意して下さい。 つまり、チェックアウトしたファイルを更新した際には、再度 install を実行する必要があります。

south をプロジェクト内に含めて settings ファイルの sys.path を変更するか、 (なるべくなら) virtualenv や pip の requirements.txt を使うことで、 ひとつのプロジェクトに対してのみ South をインストールすることもできます。 これらの使用方法は、このドキュメントの範疇ではありませんが、 他の場所にチュートリアルがあります

ここまでの手順が完了したならば、 Django へのインストール設定 に進んで下さい。

Django へのインストール設定

さて、システムへの South のインストールが完了したので、次は Django で使用するために設定します。 やることは簡単です; settings.py を開いて INSTALLED_APPS'south' を追加するだけです。

もし Django が認識しないようならば、どこかで INSTALL_APPS を上書きしていないか、 または ./manage.py shell において import south がエラーを出さずに実行できるか確認して下さい。

さあ、South がプロジェクトに読み込まれ、使う準備ができました。次は チュートリアル に進みましょう。