😦 👆🏻 🔫 अपनी खुद की QGIS प्लगइन रिपोजिटरी बनाना 📄 💶 🆓

अधिकांश सार्वजनिक रूप से उपलब्ध QGIS प्लगइन्स आधिकारिक रिपॉजिटरी में होस्ट किए जाते हैं । हालांकि, कुछ मामलों में यह आवश्यक है कि आप अपना खुद का प्लगइन रिपॉजिटरी बनाएं, उदाहरण के लिए, एक निश्चित संगठन के सहयोगियों के संकीर्ण सर्कल में अपने प्लगइन को वितरित करने के लिए। इस लेख में हम अपने स्वयं के प्लग रिपॉजिटरी को लागू करने के तरीके के बारे में देखेंगे, और न्यूनतम आवश्यकताओं पर भी चर्चा करेंगे, जो प्लग-इन को अपने रिपॉजिटरी में रखने के लिए मिलना चाहिए।

नोट 1

, QGIS . , , :

https://plugins.qgis.org/publish/

Releasing your plugin

नोट 2

, , QGIS 3.10.5 LTR.

प्लगइन प्रबंधक

प्लगइन के साथ काम करने के लिए QGIS के पास एक विशेष उपकरण है - प्लगइन प्रबंधक। यह आपको प्लगइन्स की खोज करने, उन्हें स्थापित करने और हटाने, इंस्टॉल किए गए प्लगइन्स के नए संस्करणों की उपस्थिति को ट्रैक करने, तृतीय-पक्ष रिपॉजिटरी कनेक्ट करने आदि की अनुमति देता है। प्रत्येक प्लगइन के लिए, प्लगइन प्रबंधक प्लगइन के बारे में जानकारी के साथ एक विंडो प्रदान करता है। इस जानकारी को भरने के लिए तीन परिदृश्य हैं:

प्लगइन रिपॉजिटरी में है, लेकिन आपके कंप्यूटर पर स्थापित नहीं है। इस स्थिति में, प्लगइन प्रबंधक के लिए सभी जानकारी plugins.xml फ़ाइल में प्लगइन विवरण से निकाली गई है।
प्लगइन आपके कंप्यूटर पर स्थापित है और रिपॉजिटरी के साथ एक कनेक्शन है। इस स्थिति में, जानकारी का हिस्सा अभी भी plugins.xml फ़ाइल में प्लगइन विवरण से निकाला जाता है, और मेटाडेटा फ़ाइल metadata.txt से भाग
प्लगइन आपके कंप्यूटर पर स्थापित है और रिपॉजिटरी के साथ कोई संबंध नहीं है। इस स्थिति में, प्लगइन प्रबंधक के लिए सभी जानकारी मेटाडेटा फ़ाइल से मेटाडेटा से निकाली जाती है।

नीचे दी गई तालिका बताती है कि पैरामीटर विंडो में प्लगइन के बारे में जानकारी के साथ आते हैं, प्रत्येक तीन मामलों में:

QGIS प्लगइन प्रबंधक में प्लगइन जानकारी विंडो में पैरामीटर	वह स्रोत जहाँ से रिपॉजिटरी से इंस्टॉलेशन से पहले पैरामीटर लिया जाता है	वह स्रोत जिससे पैरामीटर आपके कंप्यूटर पर प्लग-इन स्थापित होने पर लिया जाता है और रिपॉजिटरी के साथ एक कनेक्शन होता है	वह स्रोत जिससे पैरामीटर लिया जाता है जब प्लग-इन आपके कंप्यूटर पर स्थापित होता है और रिपॉजिटरी के साथ कोई संबंध नहीं होता है
नाम	plugins.xml (pyqgis_plugin टैग की संपत्ति का नाम)	plugins.xml (pyqgis_plugin टैग की संपत्ति का नाम)	metadata.txt
विवरण	plugins.xml	metadata.txt	metadata.txt
के बारे में	plugins.xml	metadata.txt	metadata.txt
स्थापित संस्करण		metadata.txt (संस्करण पैरामीटर)	metadata.txt (संस्करण पैरामीटर)
उपलब्ध संस्करण	plugins.xml ( version pyqgis_plugin)	plugins.xml ( version pyqgis_plugin)
Download url	plugins.xml	plugins.xml
Changelog		metadata.txt	metadata.txt
Tags	plugins.xml	metadata.txt	metadata.txt
Author	plugins.xml	plugins.xml	metadata.txt
Email		metadata.txt	metadata.txt
Homepage	plugins.xml	plugins.xml	metadata.txt
Bug tracker	plugins.xml	plugins.xml	metadata.txt
Code repository	plugins.xml	plugins.xml	metadata.txt
QgisMinimumVersion	plugins.xml	metadata.txt	metadata.txt
QgisMaximumVersion	plugins.xml	metadata.txt	metadata.txt
Experimental	plugins.xml	metadata.txt	metadata.txt
Deprecated	plugins.xml	metadata.txt	metadata.txt
Icon	plugins.xml	metadata.txt	metadata.txt
Category	plugins.xml	plugins.xml	metadata.txt

, QGIS, metadata.txt plugins.xml . initGui() .
Installed version Available version, QGIS . Installed version Available version, QGIS «Installed version of this plugin is higher than any version found in repository». , , .
, metadata.txt plugins.xml . .
Available version plugins.xml version pyqgis_plugin, version.
metadata.txt plugins.xml Experimental Deprecated, .
QGIS (QgisMinimumVersion) (QgisMaximumVersion) , metadata.txt plugins.xml.
, . , QgisMinimumVersion + 0.99.

रिपॉजिटरी में प्रत्येक प्लगइन को एक अलग ज़िप संग्रह में पैक किया जाना चाहिए, जिसमें रूट फ़ोल्डर मौजूद होना चाहिए, और इसमें मेटाडेटा.टेक्स्ट फ़ाइल के साथ आपके प्लगइन की फाइलें भी हैं। रूट फ़ोल्डर के नाम से, QGIS प्लगइन प्रबंधक रिपॉजिटरी में उपलब्ध प्लगइन्स के साथ स्थानीय रूप से इंस्टॉल किए गए प्लग इन से मेल खाएगा। इस तरह की तुलना के फीचर्स की चर्चा नीचे लोकल प्लगइन और रिपॉजिटरी में प्लग इन के बीच सेक्शन कम्युनिकेशन में की जाएगी ।

एक कार्यशील QGIS प्लग इन में केवल दो आवश्यक फाइलें होनी चाहिए:

__init__.py प्लगइन का शुरुआती बिंदु है। फ़ाइल में classFactory () विधि होनी चाहिए।
metadata.txt - में प्लगइन के बारे में सामान्य जानकारी है।

फ़ाइलों के न्यूनतम सेट के साथ एक प्लगइन का एक उदाहरण यहां पाया जा सकता है ।

आप आधिकारिक दस्तावेज में अधिक विस्तार से प्लगइन्स की संरचना का अध्ययन कर सकते हैं ।

मेटाडेटा फ़ाइल

जैसा कि पहले ही उल्लेख किया गया है, प्रत्येक प्लगइन की निर्देशिका में एक मेटाडेटा.टैक्स फ़ाइल होनी चाहिए जिसमें प्लगइन के बारे में सामान्य जानकारी हो। इसका उपयोग QGIS प्लगइन प्रबंधक में प्रदर्शित करने, एक प्लगइन की खोज करने आदि के लिए किया जाता है।

मेटाडेटा फ़ाइल संरचना निम्नानुसार होनी चाहिए:

[general]
Parameter1_Name: Parameter1_Value
Parameter2_Name: Parameter2_Value
…
ParameterN_Name: ParameterN_Value

या:

[general]
Parameter1_Name= Parameter1_Value
Parameter2_Name= Parameter2_Value
…
ParameterN_Name= ParameterN_Value

आप पैरामीटर नाम और उसके मान के लिए विभाजक के रूप में एक बृहदान्त्र या "=" चिह्न का उपयोग कर सकते हैं। हालाँकि, यह आवश्यक नहीं है कि एकल मेटाडेटा फ़ाइल में केवल एक प्रकार का सीमांकक हो। विभाजक के पहले और बाद के रिक्त स्थान मेटाडेटा से डेटा के पठन को प्रभावित नहीं करते हैं। इसलिए, वे किसी भी मात्रा में या अनुपस्थित हो सकते हैं। ध्यान दें कि मेटाडेटा फ़ाइल की शुरुआत में कीवर्ड "[सामान्य]" आवश्यक है।

आवश्यक पैरामीटर, जिसके बिना प्लग-इन बाधित हो सकता है, इस प्रकार हैं:

नाम - प्लगइन का नाम,
संस्करण - प्लगइन संस्करण,
qgisMinimumVersion इस प्लगइन के साथ काम करने के लिए उपयुक्त QGIS का न्यूनतम संस्करण है।

आप अन्य मापदंडों के बारे में जानकारी यहाँ पा सकते हैं ।

plugins.xml

प्रत्येक रिपॉजिटरी में एक plugins.xml फ़ाइल होनी चाहिए जो रिपॉजिटरी में उपलब्ध सभी प्लगइन्स के बारे में प्लगइन प्रबंधक के लिए सामान्य जानकारी प्रदान करती है।

ध्यान दें

, .

Plugins.xml की संरचना इस प्रकार होनी चाहिए:

<plugins>
    <pyqgis_plugin name="Plugin1_Name" version="Plugin1_Version">                 
        <Plugin1_Parameter1_Name>Plugin1_Parameter1_Value</Plugin1_Parameter1_Name>
        <Plugin1_Parameter2_Name>Plugin1_Parameter2_Value</Plugin1_Parameter2_Name>
        ....
        <Plugin1_ParameterN_Name>Plugin1_ParameterN_Value</Plugin1_ParameterN_Name>
    </pyqgis_plugin>
    ...
    <pyqgis_plugin name="PluginN_Name" version="PluginN_Version">
       <PluginN_Parameter1_Name>PluginN_Parameter1_Value</PluginN_Parameter1_Name>
       <PluginN_Parameter2_Name>PluginN_Parameter2_Value</PluginN_Parameter2_Name>
        ....
       <PluginN_ParameterN_Name>PluginN_ParameterN_Value</PluginN_ParameterN_Name>
    </pyqgis_plugin>
</plugins>

आवश्यक पैरामीटर जिसके बिना भंडार बाधित किया जा सकता है निम्नलिखित हैं:

नाम - प्लगइन का नाम (pyqgis_plugin टैग के पैरामीटर के रूप में दिखाया गया है)
संस्करण - प्लगइन का संस्करण (pyqgis_plugin टैग के पैरामीटर के रूप में निर्दिष्ट),
qgis_minimum_version - इस प्लगइन के साथ काम करने के लिए उपयुक्त QGIS का न्यूनतम संस्करण,
download_url - url जहां आपके प्लगइन के साथ ज़िप संग्रह स्थित है।

यह आधिकारिक QGIS रिपॉजिटरी (अपने कंप्यूटर पर स्थापित QGIS के संस्करण के साथ लिंक के अंत में संख्याओं को बदलें) से उदाहरण plugins.xml फ़ाइल का अध्ययन करने के लिए अनुशंसित है ।

टिप

plugins.xml, . xml.

रिपॉजिटरी में स्थानीय प्लगइन और प्लगइन के बीच संबंध

प्लगइन प्रबंधक कैसे समझता है कि आपके कंप्यूटर पर एक निश्चित प्लगइन स्थापित है और कनेक्टेड रिपॉजिटरी में एक प्लगइन एक ही प्लगइन है, उदाहरण के लिए, यह जांचने के लिए कि क्या रिपॉजिटरी में प्लगइन का एक नया संस्करण दिखाई दिया है?

तकनीकी विवरणों में जाने के बिना, प्लगइन्स को जोड़ने का नियम निम्नानुसार है: स्थानीय प्लग-इन और रिपॉजिटरी में प्लग-इन को QGIS प्लग-इन प्रबंधक द्वारा एक ही प्लग-इन माना जाता है, यदि प्लग-इन रूट फ़ोल्डर का नाम या तो टेक्स्ट से पहले बिंदु तक मेल खाता है, जो file_name टैग से पहले बिंदु से मेल खाता है, या यदि file_name टैग गायब है। डाउनलोड_url टैग से अंतिम पथ तत्व के पहले बिंदु पर पाठ के साथ।

दूसरे शब्दों में, अगर files_name टैग plugins.xml से प्लगइन विवरण में मौजूद है, तो पहले बिंदु पर भाग (बोल्ड में हाइलाइट किया गया) इसे से निकाला जाएगा, जो कि स्थापित प्लगइन के रूट फ़ोल्डर का नाम होना चाहिए जो कि QGIS प्लगइन प्रबंधक उन्हें एक मानता है और एक ही प्लगइन। यदि file_name टैग गायब है, तो डाउनलोड_url टैग से अंतिम पथ तत्व को उसी तरह पार्स किया जाएगा। इसमें से निकाले गए भाग को पहले बिंदु (बोल्ड में हाइलाइट किया गया) को भी स्थापित प्लग-इन के मूल फ़ोल्डर का नाम होना चाहिए ताकि QGIS प्लग-इन प्रबंधक उन्हें एक ही प्लग-इन मानता है। यदि रूट फ़ोल्डर के नाम और file_name से निकाले गए भाग के बीच कोई मेल नहीं है, या (यदि file_name अनुपलब्ध है) download_url से, तो प्लगइन्स को अलग-अलग प्लगइन्स माना जाता है।

<file_name>PluginName.2.1.0.zip</file_name>

<download_url>YourRepositoryURL/PluginName.2.1.0.zip</download_url>

इस नियम को ध्यान में रखते हुए, plugins_xml फ़ाइल में प्लगइन्स विवरण में file_name टैग को जोड़ने की सिफारिश की गई है, जो आपके ज़िप संग्रह का नाम नहीं दिखाता है, लेकिन आपके प्लगइन के रूट फ़ोल्डर का नाम, जिसमें आप एक संस्करण या अन्य जानकारी जोड़ सकते हैं, उन्हें एक डॉट के साथ अलग कर सकते हैं। इस स्थिति में, आप अपनी पसंद के अनुसार प्लगइन के साथ ज़िप संग्रह को नाम दे सकते हैं, जिसमें प्लगइन का नाम और उसके संस्करण को हाइफ़न के साथ अलग करना शामिल है, जैसा कि आधिकारिक रिपॉजिटरी में प्रथागत है।

ध्यान दें

QGIS file_name .

सही तरीके से डिज़ाइन किए गए प्लगइन्स के उदाहरण

उदाहरण 1

प्लगइन फ़ाइल संरचना

FolderName.SomeInfo.zip
---FolderName
------__init__.py
------metadata.txt

Metadata.txt फ़ाइल

[general]
name: PluginName
version: 2.1.0
qgisMinimumVersion: 3.0

Plugins.xml फ़ाइल

<plugins> 
   <pyqgis_plugin name="PluginName" version="2.1.0">
       <qgis_minimum_version>3.0.0</qgis_minimum_version>
        <download_url>YourRepositoryURL/FolderName.SomeInfo.zip</download_url>
   </pyqgis_plugin>
</plugins>

इस उदाहरण में, आपके कंप्यूटर पर स्थानीय रूप से इंस्टॉल किए गए प्लगइन्स और रिपॉजिटरी में प्लगइन के बीच का कनेक्शन रूट फ़ोल्डर और डाउनलोड_ल टैग के नाम से है। इसलिए, ज़िप संग्रह के नाम का पहला भाग और प्लगइन के रूट फ़ोल्डर का नाम बिल्कुल मेल खाना चाहिए।

उदाहरण 2

प्लगइन फ़ाइल संरचना

ArchiveName.SomeInfo.zip
---FolderName
------__init__.py
------metadata.txt

Metadata.txt फ़ाइल

[general]
name: PluginName
version: 2.1.0
qgisMinimumVersion: 3.0

Plugins.xml फ़ाइल

<plugins>
   <pyqgis_plugin name="PluginName" version="2.1.0">
       <qgis_minimum_version>3.0.0</qgis_minimum_version>
        <file_name>FolderName.SomeInfo</file_name>
        <download_url>YourRepositoryURL/ArchiveName.SomeInfo.zip</download_url>
   </pyqgis_plugin>
</plugins>

इस उदाहरण में, आपके कंप्यूटर पर स्थानीय रूप से इंस्टॉल किए गए प्लगइन और रिपॉजिटरी में प्लग के बीच का कनेक्शन रूट फ़ोल्डर और फ़ाइल_नाम टैग के माध्यम से है। इस स्थिति में, ज़िप संग्रह के नाम का पहला बिंदु और रूट फ़ोल्डर का नाम अलग हो सकता है।

रिपोजिटरी बनाएं

QGIS प्लगइन रिपॉजिटरी में plugins.xml फ़ाइल शामिल होनी चाहिए जो कि रिपॉजिटरी और ज़िप अभिलेखागार में उपलब्ध सभी प्लगइन्स के बारे में सामान्य जानकारी प्रदान करती है जिसमें प्लगइन्स स्वयं होते हैं। रिपॉजिटरी को GitHub या Bitbucket जैसी वेब सेवाओं पर होस्ट किया जा सकता है।

QGIS के लिए इस तरह के भंडार को पहचानने के लिए एक महत्वपूर्ण आवश्यकता एक सीधी लिंक के माध्यम से फाइलों तक पहुंचने की है। यह किया जा सकता है, उदाहरण के लिए, Github Pages या Bitbucket Pages का उपयोग करते हुए। Google ड्राइव या ड्रॉपबॉक्स इन उद्देश्यों के लिए काम नहीं करेगा। वे फ़ॉर्म की फ़ाइल ... / filename.extension पर सीधे लिंक की अनुमति नहीं देते हैं।

स्थैतिक वेबसाइट की मेजबानी के लिए GitHub का उपयोग करने के निर्देश यहां स्थित हैं ।

एक स्थिर वेबसाइट को होस्ट करने के लिए Bitbucket का उपयोग करने के निर्देश यहां पर स्थित हैं ।

एक नियम के रूप में, आपको बस टेम्पलेट के अनुसार अपनी रिपॉजिटरी का नाम बदलना होगा:

username.imtqy.com (GitHub के लिए)
या
username.bitbucket.io (Bitbucket के लिए)

आवश्यक सेटिंग्स के बाद, आपके QGIS रिपॉजिटरी का लिंक इस तरह दिखेगा:

username.imtqy.com/plugins.xml (GitHub के लिए)
या
username.bitbucket.io/plugins.xml(Bitbucket के लिए)

यह लिंक निर्दिष्ट किया जाना चाहिए नए रिपॉजिटरी को जोड़ने पर QGIS प्लगइन प्रबंधक में URL फ़ील्ड में। यदि रिपॉजिटरी का कनेक्शन सफल होता है, तो रिपॉजिटरी की स्थिति "कनेक्ट" पर सेट हो जाएगी, और plugins.xml फ़ाइल में वर्णित प्लगइन्स उपलब्ध प्लगइन्स की सूची में दिखाई देंगे।

अपनी खुद की QGIS प्लगइन रिपोजिटरी बनाना

प्लगइन प्रबंधक

मेटाडेटा फ़ाइल

plugins.xml

रिपॉजिटरी में स्थानीय प्लगइन और प्लगइन के बीच संबंध

सही तरीके से डिज़ाइन किए गए प्लगइन्स के उदाहरण

उदाहरण 1

प्लगइन फ़ाइल संरचना

Metadata.txt फ़ाइल

Plugins.xml फ़ाइल

उदाहरण 2

प्लगइन फ़ाइल संरचना

Metadata.txt फ़ाइल

Plugins.xml फ़ाइल

रिपोजिटरी बनाएं

More articles: