Frappe MCP Server

🚀 Frappe フレームワークユーザーガイド

Frappe フレームワークは、Web アプリケーションの開発と保守を支援する強力なツールです。このガイドでは、Frappe フレームワークのインストール、基本的な使い方、開発方法、およびベストプラクティスについて説明します。

🚀 クイックスタート

Frappe フレームワークを使用するためには、まずインストールと初期設定を行う必要があります。以下の手順に従って、Frappe フレームワークをセットアップしましょう。

📦 インストール

インストール手順

1. インストールパッケージのダウンロード：Frappe 公式サイト から、お使いのオペレーティングシステムに適した最新バージョンのインストールパッケージをダウンロードします。
2. 環境の準備：
   • システムに Python 3.7 以上がインストールされていることを確認してください。
   • PostgreSQL データベースをインストールし、バージョン 10 以上であることを確認してください。
3. インストールスクリプトの実行：ダウンロードしたインストールパッケージ内の setup.py スクリプトを実行し、指示に従ってインストールを完了させます。
4. 初期設定：
   • frappe init コマンドを実行して、新しいプロジェクトを作成します。
   • 指示に従って、必要なアプリケーションモジュールを選択し、初期設定を完了させます。
5. サービスの起動：python3 -m frappe serve コマンドを使用して、Frappe サービスを起動します。デフォルトのポートは 8000 です。

環境変数の設定

• FRAPPE_SITE_URL：Frappe サイトの URL を設定します。例：http://localhost:8000
• FRAPPE_SECRET_KEY：API 呼び出しに使用するキーを生成します。デフォルトはランダム文字列です。
• DATABASE_URI：データベース接続の URI を設定します。形式は postgresql://ユーザー名:パスワード@ホスト/データベース名 です。

✨ 主な機能

Doctype 管理

ドキュメントタイプの作成と編集

1. 新しい Doctype の作成：
   • Frappe の doc ディレクトリ内に、doctype_name.json という名前の JSON ファイルを新規作成します。
   • フィールド構造と検証ルールを定義します。
2. Doctype フォームのカスタマイズ：
   • HTML と JavaScript を使用してフォームインターフェイスを作成し、doctype_name.html として保存します。
   • doctype_name.js 内にイベントリスナーとカスタム関数を追加します。
3. ドキュメントタイプの有効化と無効化：
   • Frappe のシステム設定にアクセスし、Doctype 管理モジュールを見つけて、必要な操作を選択します。

ドキュメントタイプの例

# サンプルドキュメントタイプ構造
{
  "doctype": "Customer",
  "fields": [
    {"label": "顧客名", "fieldname": "customer_name", "type": "Data"},
    {"label": "顧客タイプ", "fieldname": "customer_type", "type": "Select", "options": ["個人", "企業"]}
  ],
  "validation": {
    "required_fields": ["customer_name"],
    "unique": ["customer_email"]
  }
}

データベースのやり取り

データのクエリ

1. 基本的なクエリ：
   • frappe.get_all を使用して、レコードのリストを取得します。フィルタリングとソートをサポートしています。

   customers = frappe.get_all('Customer', filters={'customer_type': '個人'}, fields=['name', 'customer_name'])
   

2. データの挿入：
   • frappe.insert メソッドを呼び出して、新しいドキュメントを追加します。

   new_customer = {
     "doctype": "Customer",
     "customer_name": "John Doe",
     "customer_type": "個人"
   }
   frappe.insert(new_customer)
   

3. データの更新：
   • frappe.update メソッドを使用して、既存のレコードを変更します。

   frappe.update('Customer', 'CUST-00001', {'email_id': 'john@example.com'})
   

4. データの削除：
   • frappe.delete メソッドを呼び出して、指定されたドキュメントを削除します。

   frappe.delete('Customer', 'CUST-00001')
   

フォームの検証とイベント

カスタムフォームの検証

// サンプル検証関数
frappe.add_events("Customer", {
  "on_submit": function(doc) {
    if (!doc.customer_name) {
      throw new frappe.ValidationError("顧客名を入力してください");
    }
  }
});

💻 使用例

基本的な使用法

# サンプルドキュメントタイプ構造
{
  "doctype": "Customer",
  "fields": [
    {"label": "顧客名", "fieldname": "customer_name", "type": "Data"},
    {"label": "顧客タイプ", "fieldname": "customer_type", "type": "Select", "options": ["個人", "企業"]}
  ],
  "validation": {
    "required_fields": ["customer_name"],
    "unique": ["customer_email"]
  }
}

高度な使用法

# 高度なシナリオの説明
customers = frappe.get_all('Customer', filters={'customer_type': '個人'}, fields=['name', 'customer_name'])

📚 ドキュメント

開発と高度な使用

プラグイン開発ガイド

1. プラグイン構造の作成：
   • プロジェクトのルートディレクトリに plugins フォルダを新規作成します。
   • プラグインのメインファイル plugin_name.js と設定ファイル plugin_name.json を作成します。
2. カスタムイベントの登録：

   frappe.plugins.register('my_plugin', {
     onReady: function() {
       console.log("プラグインが読み込まれました");
     }
   });
   

3. ドキュメントタイプの拡張：
   • doctype_name.js 内にカスタムメソッドとイベントリスナーを追加します。

API の使用方法

1. アクセストークンの取得：

   curl --user admin:admin_pass http://localhost:8000/api/method/frappe.auth.get_token
   

2. REST API の呼び出し：

   curl -X GET "http://localhost:8000/api/resource/doctype/Customer"
   

3. ファイルアップロードの処理：

   curl -F file=@/path/to/image.jpg "http://localhost:8000/api/method/frappe.core.doctype.file_manager.upload_file"
   

ベストプラクティス

パフォーマンスの最適化

1. データベースインデックスの最適化：
   • よく使用されるクエリフィールドにインデックスを作成し、クエリの効率を向上させます。

   CREATE INDEX idx_customer_name ON Customer(customer_name);
   

2. キャッシュメカニズムの適用：
   • frappe.cache モジュールを使用して、頻繁にアクセスされるデータをキャッシュし、データベースの負荷を軽減します。
3. 非同期タスクの処理：
   • Celery などのツールを利用して、タスクキューを実装し、システムの応答速度を向上させます。

セキュリティに関する注意事項

1. 権限管理：
   • 適切なロールと権限を設定し、ユーザーの権限を最小限に抑えます。

   frappe.add_perm("Customer", "Sales User", "read");
   

2. ログ記録：
   • 詳細なログ記録を有効にし、システムの動作を監視し、異常を早期に発見します。
3. 定期的なセキュリティ監査：
   • 定期的にシステムの脆弱性をチェックし、コンポーネントを最新バージョンに更新して、システムのセキュリティを確保します。

これらのガイドとベストプラクティスに従うことで、Frappe フレームワークを効率的に使用して、Web アプリケーションを開発および保守することができます。