Skip to main content

Getting Ready for Quantum GIS Plugin Development

Quantum GIS (QGIS) is a desktop GIS application that can be extended with Python plugins. We are going to use Plugin Builder from within QGIS. Plugin Builder is not installed by default. Start QGIS and follow these steps to install Plugin Builder:


Installing Plugin Builder

  1. Select Plugins->Fetch Python Plugins. A QGIS Python Plugin Installer dialog box will open.
  2. Select Repositories tab.
  3. Click on Add 3rd party repositories button. A confirmation dialog box will appear. Click Ok. Another dialog box will appear to fetch the repositories. The dialog box will close itself.
  4. Select Plugins tab.
  5. Select Plugin Builder from the list.
  6. Click on Install Plugin button.

Plugin Builder menu will appear in Plugins menu. Select Plugins->Plugin Builder->Plugin Builder to start the Plugin Builder. A QGIS Plugin Builder dialog box will appear.


Generating QGIS Python plugin file set


We use the Plugin Builder to generate a basic file set for our QGIS Python plugin. Fill in the QGIS Plugin Builder dialog box with our plugin details. Click Ok. Select the directory where we want to keep our plugin. The Plugin Builder will generate the files in the directory we chose and will give us the following instruction (assuming that we name our plugin myplugin):

  1. Copy the entire directory containing your new plugin to the QGIS plugin directory
  2. Compile the ui file using pyuic4 (refer to Compiling our plugin section below) 
  3. Compile the resources file using pyrcc4 (refer to Compiling our plugin section below) 
  4. Test the plugin by enabling it in the QGIS plugin manager (refer to Tesing our plugin section below)
  5. Customize it by editing the implementation file myplugin.py
  6. Create your own custom icon, replacing the default icon.png
  7. Modify your user interface by opening ui_myplugin.ui in Qt Designer (don't forget to compile it with pyuic4 after changing it)
  8. You can use the Makefile to compile your Ui and resource files when you make changes. This requires GNU make (gmake)

Compiling our plugin


See Setting Up PyScripter for Quantum GIS on how to open a command prompt window that we can use to compile our plugin.


1. Compiling resources.qrc into resources.py

pyrcc4 -o resources.py resources.qrc
2. Compiling ui_myplugin.ui into ui_myplugin.py

pyuic4 -o ui_myplugin.py ui_myplugin.ui
We can design our user interface (ui) using Qt Designer which is bundled in Qt SDK. Open ui_myplugin.ui from within Qt Designer. Once we make a ui change we need to recompile it with pyuic4.


Testing our plugin

  1. Compile resources.grc and ui_myplugin.ui.
  2. Select Plugins->Manage Plugins. A QGIS Plugin Manager dialog box will appear.
  3. Select our plugin from the list. Click Ok to install it.
  4. Our plugin menu will appear in Plugins menu. Click on it.

Note: Each time we make changes to our plugin we need to restart QGIS.

Comments

  1. AnonymousNovember 4, 2012 at 7:46 PM

    Wish I'd found this POST earlier. THANKS!!

    Only problem was I had to edit myplugin.py line 27 to change "import resources_rc" to "import resources" (i.e. remove the _rc on import of resources.

    ReplyDelete

Post a Comment

Popular posts from this blog

Setting Up PyScripter for Quantum GIS

PyScripter is a general purpose Python Integrated Development Environment (IDE). Quantum GIS (QGIS) is a desktop GIS application that can be extended with Python plugins. Both are open source softwares. We intend to use PyScripter as an IDE to build QGIS Python plugin. We are using PyScripter 2.4.1.0 and QGIS 1.6.0 in Windows. PyScripter does not come with Python. On the other hand, QGIS is built in with Python. Thus, we will setup up PyScripter to use the build in Python in QGIS. We assume both PyScripter and QGIS are already installed. Preparing PyScripter batch file We assume that QGIS is installed in C:\OSGeo4W\ folder and PyScripter is installed in C:\Program Files\PyScripter\ . 1. Copy qgis.bat in C:\OSGeo4W\ bin to pyscripter.bat 2. Edit pyscripter.bat to remove the last line that read something like this start "Quantum GIS" /B "%OSGEO4W_ROOT%"\apps\qgis\bin\qgis.exe %* and replace it with this in one line Start "PyScripter" /B "C:\Progr...
8 comments
Read more

Access Control

Access control is about controlling user flow within your application. Do not mistaken access control with security which is a bigger subject in itself. Access control begins by authenticating user and limit his or her activity in your application. An activity is something like creating, updating or deleting a content. There are always finite number of activities that can be done in a given application. Each user can be assigned to a set of activities that he or she is allowed to do. Access control is usually tied to session management. However, you do not need session management to have access control. When a user log in, a session is created so that the user is remembered for the subsequent access. Otherwise the user has to keep on providing his or her credential for each access. We can also keep a list of activities that the user is allowed to do in the session record. Some applications let the session alive indefinitely and some applications time out user after a duration of inacti...
Post a Comment
Read more

Separation of Front-end and Back-end Concerns

Separation of concerns is the cornerstone of MVC framework. Model, view and controller are three broad concerns of web-based software development. On its early days MVC was implemented on server side. The server renders views for clients. Nowadays, most clients render views themselves. Even the terminology of client-server has already morphed into front-end and back-end . The need for back-end to handle views is diminishing. View concerns have became increasingly complex with two big sub-concerns of aesthetic and dynamics. Front-end evolves into bigger MVC concerns of itself. While back-end evolves into larger modeling concerns. Now, front-end and back-end are two separate concerns. Front-end and back-end are handled by two different teams of software developers with different specialties. Back-end evolves into something like "dinner can be served even without plates, forks and spoons, without table and chairs, and without a dinning room." Front-end is serving the withouts....
Post a Comment
Read more