この記事でわかること
自作のQGISプラグインを公式リポジトリで公開することができます
はじめに
QGISでプラグインを作成したので公式リポジトリに登録、公開してみます。
QGISプラグインの公開方法は、こちらの「How to publish your plugins on the repository」に記載されています
プラグインを作成する
matadata.txtの記載内容
まずはプラグインを作成します。
プラグインには、「metadata.txt」というプラグインの名称や機能説明などを記載したテキストファイルを作成します。
このmetadata.txtには、必ず記載しなければいけない必須事項がありますので、忘れずに記載しましょう。
name：プラグインの名称
qgisMinimumVersion：動作確認したQGISのバージョン
description：プラグインの説明
email：作者のメールアドレス
homepage：公開しているホームページ
tracker：問題報告できるサイト
動作確認する
作成したプラグインは一つのフォルダにまとめて、ZIPファイルに圧縮しておきます。
公開前に、必ずQGISで動作確認します。QGISのメニュー「プラグイン」＞「プラグインの管理とインストール」＞「ZIPからインストール」で作成したZIPファイルからインストールできますので、インストールして動作確認してください。
また、プラグインのZIPファイルは次の条件を満たしておいてください
- ZIPファイルの中には、「LICENSE」ファイルが必要
- ZIPファイルは25MB以内にする必要があります
Githubに公開する
必須ではありませんが、プラグインをGithubで公開しておくと更新したときに便利です。
また、Issuesで問題の報告を受け取ることも可能です。
同じ機能のプラグインがないか確認する
すでに公開されているプラグインを検索して、同じ機能のプラグインがないか確認しておきましょう。
OSGeoのUserIDを取得する
プラグインの公開には、「OSGeo」のUserIDの取得が必要です。
OSGeoのページにアクセスしてUserIDを取得しましょう。
IDの取得には「mantra phrase（マントラフレーズ）」をリクエストして、送られてきた「mantra」を入力する必要があります。
「2. Email template:」の「◯Publish QGIS plugin from source at・・・・」にチェックを付けると、メールのテンプレートが更新されるので、コピーしてメールで送ります。
企業、大学、団体に所属している場合は、組織のアカウントから送るといいようですが、私の場合は個人開発なので個人のGmailアカウントで送ります。
次の項目を記載しておくと良いようです。
- プラグインを公開しているURL
- 送信したメールアドレスが記載されている自身のホームページ等
- OSGeoのメーリングリストに投稿したことがあるときは、そのアーカイブのURL
- GitLabのプロフィール（メールアドレスを記載）
- GitHubのプロフィール（メールアドレスを記載）
私がGmailで送信したときには、「Mail Delivery System」から「メールが届きませんでした」と返信が届きましたが、次の日に返事が来ていたので届いているようでした。
届いたメールには、mantra文字列が記載されていますので、下の図のテキストボックスに入力し、「Continue」ボタンをクリックします。
次に、ID登録画面に移動しますので、必要事項を入力してIDを登録しましょう。
プラグインをアップロードする
QGISのWebサイトでプラグインをアップロードします。
まずは、ログインページで先程取得したOSGeoのUserIDでログインします。
ログインするとアップロードページが表示されるので「Plugin Package」ボタンをクリックして、プラグインのZIPファイルを選択します。
「Upload」ボタンをクリックすると、ファイルがアップロードされます。
ファイルがアップロードされると、プラグインの登録ページに移動します。
承認されると、公開されるようです。
承認された
３日経って、プラグインが承認されて公開されました。
特にメールなどは来ないようですね。
公開されたら、自動翻訳に対応できるようにコードを修正したとのメールが有りました。翻訳ファイルが追加されているようでした。
おわりに
プラグインを公式リポジトリでの公開は、承認までの時間がかかりますが比較的簡単に行うことができます。
もし、自作のプラグインを作成したという方は、ぜひ公式リポジトリに公開しましょう！
QGISならエアロトヨタ株式会社
エアロトヨタ株式会社では、QGIS基礎研修、QGIS応用研修など幅広い学習プログラムを用意しています。防災、森林、都市計画など専門分野に特化した研修も準備しています。
実際に業務に使っているデータを使って、QGISを学習することが可能です！
また、QGISを利用した業務改善、社内や庁内データの利活用などを提案しております。
お気軽にご相談ください。
エアロトヨタ株式会社ーQGIS
QGISコラム エアロトヨタ株式会社