Outdated version of the documentation. Find the latest one here.

プラグインをリリースする

プラグインの準備ができ、そのプラグインが誰かのために役立つことあると思ったら、躊躇わずに:ref: `official_pyqgis_repository`にアップロードしてください。そのページでは、プラグインのインストーラでうまく動作するプラグインを準備する方法についてパッケージ化のガイドラインも見つかります。あるいは、独自のプラグインのリポジトリを設定したい場合は、プラグインとそのメタデータの一覧を表示する単純なXMLファイルを作成してください。例は他の `プラグインリポジトリ<http://www.qgis.org/wiki/Python_Plugin_Repositories> `_を参照してください。

次の提案に特別な注意してください:

メタデータと名前

  • 既存のプラグインとあまりにも類似した名前を使用しないよう

  • プラグインが既存のプラグインと類似の機能を持っている場合は、「このプラグインについて」フィールドに違いを説明し、ユーザーがインストールして試さなくてもどれを使用するべきかわかるようにしてください

  • プラグイン自体の名前に「プラグイン」を繰り返さないよう

  • より詳細な手順については、1行の説明のためのメタデータでは約フィールドを説明フィールドを使用します

  • コードリポジトリ、バグトラッカー、およびホーム・ページが含まれます。これは非常にコラボレーションの可能性を向上させます、そして利用可能なWebインフラストラクチャの1つ(GitHubの、GitLab、のBitbucketなど)で非常に簡単に行うことができます

  • 注意してタグを選択します(例:ベクトル)情報価値のないものを避け、すでに他のユーザーによって使用されるものを好む(プラグインのWebサイトを参照してください)

  • 適切なアイコンを追加、デフォルトの1のままにしないでください。使用するスタイルの提案のためのQGISインターフェースを参照してください

コードとヘルプ

  • リポジトリに(例えば.gitignore)生成されたファイル(UI _ *。PY、resources_rc.py、生成されたヘルプファイル...)と役に立たないものを含みません

  • 適切なメニューにプラグインを追加(ベクター、ラスター、ウェブ、データベース)

  • 適切な場合(解析を実行するプラグイン)、処理フレームワークのsubpluginとしてプラグインを追加することを検討:これは、ユーザーがバッチでそれを実行できるようになり、より複雑なワークフローでそれを統合するために、インターフェイスを設計する負担からあなたを解放します

  • 最低限のドキュメンテーションと、テストと理解に役立つ場合はサンプルデータを含めてください。

公式のpythonプラグインリポジトリ

*公式の*pythonプラグインリポジトリは http://plugins.qgis.org/ で見つけることができます。

公式のリポジトリを使用するため、あなたは OSGEO web portal からOSGEO IDを入手しないといけません。

あなたがプラグインをアップロードしたら、それはスタッフによって承認され、あなたに通知されます。

TODO:

ガバナンスのドキュメントへのリンクを挿入

許可

これらのルールは、公式のプラグインリポジトリに実装されています:

  • すべての登録ユーザは、新しいプラグインを追加することができます

  • *スタッフ*は全てのプラグインバージョンの承認と非承認を行うことができます。

  • 特別な権限 `plugins.can_approve`を持つユーザーがアップロードしたバージョンは自動的に承認されます

  • 特別な権限`plugins.can_approve`を持つユーザーは、彼らがプラグイン*所有者*のリスト中にある限り、他人によってアップロードされたバージョンを承認できます

  • 特定のプラグインは *スタッフ*ユーザまたはプラグイン *所有者*によって削除または編集できます。

  • ユーザが`plugins.can_approve`なしで新しいバージョンをアップロードした場合、プラグインのバージョンは自動的に非承認になります。

運用の信託

スタッフはフロントエンドアプリケーションを介して `plugins.can_approve`許可を設定し、選択したプラグインの作成者に*信頼*を付与することができます。

プラグインの詳細ビューには、プラグインの作成者やプラグイン*所有者*への信頼を付与するために直接リンクを提供しています。

検証

プラグインのメタデータを自動的にインポートし、プラグインがアップロードされたときに圧縮されたパッケージから検証されます。

公式リポジトリ上にプラグインをアップロードするときに注意するべき検証規則がいくつかあります:

  1. プラグインを含むメインフォルダの名前は、ASCII文字(A-Zおよびa-z)、数字、アンダースコア(_)とマイナス( - )しか含んではならず、また数字で始めることはできません。

  2. metadata.txt が必要です

  3. REF:に記載されているすべての必要なメタデータ `メタデータテーブル1`存在している必要があります

  4. `VERSION`メタデータフィールドは一意である必要があります

プラグイン構造

検証に続いて、プラグインの圧縮(.zipファイル)パッケージは、機能プラグインとして検証する特定の構造を持たなければならないルール。プラグインは、プラグインフォルダをユーザーの内部で解凍されるように、それは他のプラグインに干渉しないように.zipファイル内の独自のディレクトリです持っている必要があります。必須ファイルは、次のとおりです:ファイル: metadata.txt`と:ファイル: __init __ py`。(:ファイル: resources.qrc)プラグインを表現するために` README`そしてもちろんアイコン:ファイル:しかし、持っていいだろう。以下はplugin.zipがどのように見えるべきかの一例です。

plugin.zip
  pluginfolder/
  |-- i18n
  |   |-- translation_file_de.ts
  |-- img
  |   |-- icon.png
  |   `-- iconsource.svg
  |-- __init__.py
  |-- Makefile
  |-- metadata.txt
  |-- more_code.py
  |-- main_code.py
  |-- README
  |-- resources.qrc
  |-- resources_rc.py
  `-- ui_Qt_user_interface_file.ui