---
title: "セットアップ"
url: https://docs.catalyst.zoho.com/ja/sdk/python/v1/setup/
description: "このページでは、Python SDKのセットアップと初期化の手順について説明します。"
last_updated: 2026-08-06T05:54:02Z
service: All Services
type: general
related_links:
  - name: "Install Python"
    url: https://www.python.org/
  - name: "Install Pip"
    url: https://pip.pypa.io/ja/stable/installation/#
  - name: "SDK Scopes"
    url: /ja/sdk/python/v1/sdk-scopes
---

# Python SDK セットアップ

### 前提条件

ローカル環境でCatalyst Python SDKを使用してアプリケーションロジックの開発を始める前に、以下のパッケージマネージャーとプログラミング環境がローカルマシンにインストールされていることを確認してください：

* **[Pip](https://pip.pypa.io/ja/stable/installation/#) - Pythonパッケージマネージャー**
* **[Python バージョン 3.9 〜 3.13](https://www.python.org/)**

Pythonは[公式ウェブサイト](https://www.python.org/)からインストールでき、pipパッケージマネージャーはローカルシステムに自動的にインストールされます。他のソースからPythonをインストールする場合は、pipパッケージを手動でインストールしてください。pipのインストールについては、[pipインストールドキュメント](https://pip.pypa.io/ja/stable/installation/#)を参照してください。

> **注意:** ローカルマシンにサポートされている範囲外のバージョンのPython（Python 3.9〜3.13以外のバージョン）がインストールされている場合、アプリケーションの[サーブ](https://docs.catalyst.zoho.com/ja/cli/v1/serve-resources/introduction)または[デプロイ](https://docs.catalyst.zoho.com/ja/cli/v1/deploy-resources/introduction)時に、ディレクトリ内のPython関数の実行がスキップされます。これらのPython関数は、コンソールから[CLI](https://docs.catalyst.zoho.com/ja/getting-started/installing-catalyst-cli/)に関数を[プル](https://docs.catalyst.zoho.com/ja/cli/v1/pull-resources/introduction)する際にも除外されます。

既存のCatalystプロジェクトのローカルディレクトリでPython関数を作成する場合は、上記の前提条件をインストールしてから、関数のセットアップに進んでください。既存の[プロジェクトディレクトリ](https://docs.catalyst.zoho.com/ja/cli/v1/project-directory-structure/introduction)でPython関数をセットアップする手順は、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/cli/v1/working-with-functions/introduction)に記載されています。Catalystプロジェクトの初期化時にPython関数を初期化する方法については、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/introduction)を参照してください。

### SDKのインストール

CLIでCatalystプロジェクトを初期化し、ローカル環境の既存のプロジェクトディレクトリでPython関数を[作成](https://docs.catalyst.zoho.com/ja/cli/v1/initialize-resources/initialize-functions/#initialize-a-python-function-of-any-type)または[セットアップ](https://docs.catalyst.zoho.com/ja/cli/v1/working-with-functions/set-up-functions/#set-up-a-python-function-of-any-type)すると、Python SDKパッケージ（`zcatalyst-sdk`）が現在のプロジェクトの[functionsディレクトリ](https://docs.catalyst.zoho.com/ja/cli/v1/project-directory-structure/introduction)内に自動的にインストールされます。

任意のプログラミングスタックの[Catalyst Serverless function](https://docs.catalyst.zoho.com/ja/serverless/help/functions/introduction)を作成すると、メイン関数ファイルと設定ファイルがデフォルトでボイラープレートコードとともに関数のディレクトリに自動生成されます。Python関数の場合は、[`requirements.txt`](https://docs.catalyst.zoho.com/ja/cli/v1/project-directory-structure/functions-directory/#python-modules-and-function-dependencies)という名前の追加ファイルも作成されます。このファイルには、Python関数を実装するために必要なインストール済み依存関係のリストが含まれています。CLIからPython関数を作成すると、デフォルトでCatalystのPython SDKパッケージ（`zcatalyst-sdk`）のエントリが含まれます。外部の依存関係をインストールする必要がある場合は、`requirements.txt`ファイルに依存関係の名前を手動で追加する必要があります。

> **注意:** Python関数を初めて初期化する場合は、システムにインストールされているPythonのパス情報を追加で設定する必要があります。この情報は、ローカルシステムに隠しファイルとして存在する特定の設定ファイルで設定できます。パスは`config:set <key=value>` CLIコマンドを使用して設定する必要があります。このコマンドの詳細については、[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/cli/v1/cli-config/)を参照してください。

以下のコマンドを使用して、Catalyst Python SDKをシステムにグローバルにインストールできます：

```json
pip install zcatalyst-sdk

```

### SDKの初期化

Python SDKが関数のディレクトリにインストールされたら、Python関数のコーディングを開始できます。まず、現在のプロジェクトのCatalystコンポーネントにアクセスするために、関数のコード内で`initialize()`メソッドを使用してSDKを初期化する必要があります。Catalyst関数タイプの初期化メソッドを以下に示します：

**Basic I/O Functions**

```python
import zcatalyst_sdk
def handler(context, basicio):
  app = zcatalyst_sdk.initialize()
  #このapp変数はCatalystコンポーネントにアクセスするために使用されます。
  #ここにビジネスロジックを記述する

```

**Advanced I/O Functions**

```python
import zcatalyst_sdk
def handler(request: Request):
  app = zcatalyst_sdk.initialize()
  #このapp変数はCatalystコンポーネントにアクセスするために使用されます。
  #ここにビジネスロジックを記述する

```

**Event Functions**

```python
import zcatalyst_sdk
def handler(event, context):
  app = zcatalyst_sdk.initialize()
  #このapp変数はCatalystコンポーネントにアクセスするために使用されます。
  #ここにビジネスロジックを記述する

```

**Cron Functions**

```python
import zcatalyst_sdk
def handler(cron_details, context):
  app = zcatalyst_sdk.initialize()
  #このapp変数はCatalystコンポーネントにアクセスするために使用されます。
  #ここにビジネスロジックを記述する

```

関数内でSDKパッケージを初期化すると、レスポンスとしてPythonオブジェクトが返されます。このオブジェクトを使用して、Pythonクラスで定義されたコンポーネント固有のメソッドを呼び出し、必要なCatalystコンポーネントにアクセスできます。

> **注意 :** Python関数は、お好みに応じてウェブコンソールまたはCLIから作成できます。ただし、現時点ではローカルから関数バンドルをアップロードすることのみが可能で、コンソールで直接コーディングすることはできません。今後、オンラインエディターのサポートを提供する予定です。

### スコープを使用した初期化

Catalystでは、以下のスコープを使用してプロジェクトのSDKを初期化できます：

* **Admin**: すべてのコンポーネントとそれぞれの機能に無制限にアクセスできます。たとえば、[Data Store](https://docs.catalyst.zoho.com/ja/cloud-scale/help/data-store/introduction/)に完全にアクセスして、読み取り、書き込み、削除などのすべての操作を実行できます。

* **User**: コンポーネントや特定の機能へのアクセスを制限できます。たとえば、Data Storeに読み取りアクセスのみを提供できます。

> **注意:**

* スコープを使用してプロジェクトを初期化することは必須ではありません。デフォルトでは、初期化されたプロジェクトには*Admin*権限が付与されます。

* ビジネスロジックを設計する際には、適切なスコープでCatalyst SDKを初期化していることを確認してください。スコープに対して定義した権限が、エンドユーザーのアクションを制御します。

* さまざまなコンポーネントで実行できるSDK操作のスコープの詳細については、[スコープテーブル](https://docs.catalyst.zoho.com/ja/sdk/python/v1/sdk-scopes)を参照してください。

* ビジネスロジックの設計方法に応じて、エンドユーザーが*Admin*または*User*のアクションを実行できるかどうかを決定できます。これは、エンドユーザーがCatalyst Authenticationでアプリケーションにサインアップする際に割り当てられる[ロール](https://docs.catalyst.zoho.com/ja/cloud-scale/help/authentication/user-management/roles/introduction/)に基づいて決定されます。ロールの権限は、[Data Store](https://docs.catalyst.zoho.com/ja/cloud-scale/help/data-store/scopes-and-permissions/)と[Stratus](https://docs.catalyst.zoho.com/ja/cloud-scale/help/stratus/introduction/)の*Scopes & Permissions*または*Bucket Permissions*セクションでそれぞれ設定できます。

* Catalyst Stratusは、**Early Access**モードの新しいオブジェクトストレージコンポーネントです。Stratusコンポーネントの詳細については、[こちら](https://docs.catalyst.zoho.com/ja/cloud-scale/help/stratus/introduction/)をご覧ください。
Early AccessモードのStratusコンポーネントをご利用になるには、[**support@zohocatalyst.com**](mailto:support@zohocatalyst.com)までメールでお問い合わせください。

以下のSDKスニペットを使用すると、*Admin*または*User*スコープでSDKを初期化できます：

**Admin Scope**

```python
import zcatalyst_sdk
def handler(request: Request):
  app = zcatalyst_sdk.initialize(scope='admin')
  #このapp変数はCatalystコンポーネントにアクセスするために使用されます。
  #コードサンプルについてはSDKドキュメントを参照してください。
  #ここにビジネスロジックを記述する

```

**User Scope**

```python
import zcatalyst_sdk
def handler(request: Request):
  app = zcatalyst_sdk.initialize(scope='user')
  #このapp変数はCatalystコンポーネントにアクセスするために使用されます。
  #コードサンプルについてはSDKドキュメントを参照してください。
  #ここにビジネスロジックを記述する

```

次のセクションでは、Python SDKのアップグレードについて説明します。