This page's factual accuracy may be compromised due to out-of-date information. Please help improve the Gramps Wiki as a useful resource by updating it.
This page documents the API, methods, and best practices for developing a 3rd-party addon for Gramps 3.2 and later
Addons for Gramps can extend the program in many different ways. You can add any of the following types of addons:
- Doc creator
- Plugin lib
- Map service
- Gramps View
Writing an addon is fairly straightforward if you have just a little bit of Python experience. And sharing your addon is the right thing to do. The general steps to writing an addon and sharing your own addons are:
- Develop your addon
- Create a Gramps Plugin Registration file (.gpr.py)
- Get translators to translate your addon into multiple languages
- Package your addon
- List and document your addon
- Support it through the issue tracker
- Maintain the code as Gramps continues to evolve
We'll now look at each of these steps in detail.
- 1 Develop your addon
- 1.1 Gramps 4.1 and earlier
- 1.2 Gramps 4.2 and later
- 1.3 Follow the development API for your tool
- 1.4 Test your addon as you develop
- 1.5 Commit your changes
- 1.6 Config
- 1.7 Localization
- 2 Create a Gramps Plugin Registration file
- 3 Get translators to translate your addon into multiple languages
- 4 Package your addon
- 5 List your addon in the Gramps Plugin Manager
- 6 List and document your addon on the wiki
- 7 Miscellaneous commands
- 8 Support it through issue tracker
- 9 Maintain the code as Gramps continues to evolve
- 10 Resources
Develop your addon
Gramps 4.1 and earlier
The gramps-addons subversion repository has the following structure:
The contrib subdirectories hold the source code for the addons for a particular version. If you are working on a addon for gramps4.1
then you should be working in gramps-addons/branches/gramps4.1
/contrib. If you are working in gramps/trunk then you should use gramps-addons/trunk/contrib.
Gramps 4.2 and later
The addons-source git repository has the following structure:
The addons git repository has the following structure:
addon-source holds the source code for the addons with branches holding the version for different gramps. If you are working on a addon for gramps for gramps42 or later then you should be working in addons-source.
Setup the addon development tools for Gramps 4.1 and earlier
These steps show how to download and work with the addon development tools.
To use make.py as shown throughout this document, you may have to use:
GRAMPSPATH=/path/to/gramps python make.py ...
if the default ("../../..") is not correct.
- Checkout the gramps-addons files from the gramps-addons project:
- cd into gramps trunk, for example:
- Checkout gramps-addons:
svn co https://svn.code.sf.net/p/gramps-addons/code gramps-addons
- Change to trunk or branches/gramps41 directory:
- cd into gramps trunk, for example:
- Make a new project directory in gramps-addon/branches/gramps41/contrib:
- Initialize the addon:
./make.py init NewProjectName
Follow the development API for your tool
Follow the development API for your tool, report, view, or Gramplets. Place all of your associated .py, .glade, etc. files in this directory. For general information on Gramps development see Portal:Developers and Writing a Plugin specifically.
Test your addon as you develop
To test your addon as you develop it it is suggested that you replace your Gramps user plugin directory with a link to your addon development directory, like so:
cd ~/.gramps/gramps41/ mv plugins/* /wherever/trunk/gramps-addons/branches/gramps41/contrib/ rm -rf plugins ln -s /wherever/trunk/gramps-addons/branches/gramps41/contrib plugins
Gramps will search this folder (and subdirectories) for .grp.py files, and add them to the plugin list.
If you have code that you want to share between addons, you don't need to do anything special. Currently, Gramps adds each directory in which a .gpr.py is found onto the PYTHONPATH which is searched when you perform an import. Thus "import NewProjectName" will work from another addon. You should always make sure you name your addons with a name appropriate for Python imports.
Commit your changes
To commit your changes so that others can use your addon.
Gramps 4.1 and earlier
For Gramps 4.1 and earlier follow these steps:
- Get an http://sourceforge.net account if you don't already have one.
- Request SVN write access for the gramps-addon project by emailing one of the admins of the project (listed under the gramps-addon title next to the group icon) from http://sourceforge.net/projects/gramps-addons/
- Remove the files that should not be added to SVN:
./make.py clean NewProjectName
- Add the project to the repository:
svn add NewProjectName
svn commit -m "A message describing what this addon is"
Before making additional edits to your addon, you should:
svn commit -m "A message describing the changes"
Also you may want to Package your addon so it can be downloaded via the plugin manager.
Gramps 4.2 and later
For Gramps 4.2 and later follow these steps:
- Get an https://github.com/join account if you don't already have one.
- Request GIT write access for the https://github.com/gramps-project/addons-source project by emailing the gramps-devel mailing list
See also git introduction.
git clone email@example.com:gramps-project/addons-source.git addons-source
or if you do not have a Github account:
git clone https://github.com/gramps-project/addons-source.git addons-source
To switch to a local copy of the gramps42 branch:
git checkout -b gramps42 origin/maintenance/gramps42
Some addons may want to have persistent data (data settings that remain between sessions). You can handle this yourself, or you can use Gramps' built-in configure system.
At the top of the source file of your addon, you would do this:
from config import config as configman config = configman.register_manager("grampletname") # register the values to save: config.register("section.option-name1", value1) config.register("section.option-name2", value2) ... # load an existing file, if one: config.load() # save it, it case it didn't exist: config.save()
This will create the file "grampletname.ini" and put in the same directory as the addon. If the config file already exists, it remains intact.
In the addon, you can then:
x = config.get("section.option-name1") config.set("section.option-name1", 3)
and when this code is exiting, you might want to save the config. In a Gramplet that would be:
def on_save(self): config.save()
If your code is a system-level file, then you might want to save the config in the Gramps system folder:
config = configman.register_manager("system", use_config_path=True)
This, however, would be rare; most .ini files would go into the plugins directory.
In other code that might use this config file, you would do this:
from config import config as configman config = configman.get_manager("grampletname") x = config.get("section.option-name1")
For general help on translations in Gramps, see Coding for translation. However, that will only use translations that come with Gramps, or allows you to contribute translations to the Gramps core. To have your own managed translations that will be packaged with your addon, read the rest of this page.
For any addon which you have translations into other languages, you will need to add a way to retrieve the translation. You need to add this to the top of your NewProjectName.py file:
For Gramps 3:
from TransUtils import get_addon_translator _ = get_addon_translator(__file__).gettext
For Gramps 4:
from gramps.gen.const import GRAMPS_LOCALE as glocale _ = glocale.get_addon_translator(__file__).gettext
Then you can use the standard "_()" function to translate phrases in your addon.
You can use one of a few different types of translation functions:
Gramps 3 also provides:
These have become obsolete in Gramps 4; gettext, ngettext, and sgettext always return translated strings in unicode for consistent portability between Python 2 and Python3.
See the python documentation for documentation of gettext and ngettext. The "l" versions return the string encoded according to the currently set locale; the "u" versions return unicode strings in Python2 and are not available in Python 3.
sgettext is a Gramps extension that filters out clarifying comments for translators, such as
_("Remaining names | rest")
Where "rest" is the English string that we want to present and "Remaining names" is a hint for translators.
Create a Gramps Plugin Registration file
First, create the NewProjectName.gpr.py file. The registration takes this general form:
register(PTYPE, gramps_target_version = "3.4", version = "1.0.0", ATTR = value, )
PTYPE is TOOL, GRAMPLET, REPORT, QUICKVIEW, IMPORT, EXPORT, DOCGEN, GENERAL, MAPSERVICE, VIEW, or RELCALC.
ATTR depends on the PTYPE. But you must have gramps_target_version and version. gramps_target_version should be a string of the form "X.Y" version number matching Gramps X major, Y minor integer. version is a string of the form "X.Y.Z" representing the version of your addon. X, Y, and Z should all be integers.
Here is a sample Tool GPR file:
register(TOOL, id = 'AttachSource', name = _("Attach Source"), description = _("Attaches a shared source to multiple objects."), version = '1.0.0', gramps_target_version = '3.4', status = STABLE, fname = 'AttachSourceTool.py', authors = ["Douglas S. Blank"], authors_email = ["firstname.lastname@example.org"], category = TOOL_DBPROC, toolclass = 'AttachSourceWindow', optionclass = 'AttachSourceOptions', tool_modes = [TOOL_MODE_GUI] )
You can see examples of the kinds of addons here (for example, see gramps/source/ci/master/tree/gramps/plugins/drawreport/drawplugins.gpr.py) and see the full documentation here in the comments and docstrings.
Note that this .gpr.py will automatically use translations if you have them (see below). That is, the function "_" is predefined to use your locale translations; you only need to mark the text with _("TEXT") and include a translation of "TEXT" in your translation file. For example, in the above example, _("Attach Source") is marked for translation. If you have developed and packaged your addon with translation support, then that phrase will be converted into the user's language.
The possible report categories are (gen/plug/_pluginreg.py):
#possible report categories CATEGORY_TEXT = 0 CATEGORY_DRAW = 1 CATEGORY_CODE = 2 CATEGORY_WEB = 3 CATEGORY_BOOK = 4 CATEGORY_GRAPHVIZ = 5 REPORT_CAT = [ CATEGORY_TEXT, CATEGORY_DRAW, CATEGORY_CODE, CATEGORY_WEB, CATEGORY_BOOK, CATEGORY_GRAPHVIZ]
Each report category has a set of standards and interface. The categories CATEGORY_TEXT and CATEGORY_DRAW use the Document interface of Gramps. See also Report API for a draft view on this. The application programming interface or API for reports is treated at Report-writing_tutorial. For general information on Gramps development see Portal:Developers and Writing a plugin specifically.
The plugin framework also allows you to create generic plugins for use. This includes the ability to create libraries of functions, and plugins of your own design.
Example: A library of functions
In this example, a file name library.py will be imported at time of registration (when Gramps starts):
# file: library.gpr.py register(GENERAL, id = 'My Library', name = _("My Library"), description = _("Provides a library for doing something."), version = '1.0', gramps_target_version = '3.4', status = STABLE, fname = 'library.py', load_on_reg = True, )
The code in the file library.py will be imported when Gramps begins. You can access the loaded module in other code by issuing an "import library" as Python keeps track of files already imported. However, the amount of useful code that you can run when the program is imported is limited. You might like to have the code do something that requires a dbstate or uistate object, and neither of these is available when just importing a file.
If "load_on_reg" was not True, then this code would be unavailable until manually loaded. There is no automatic mechanism in Gramps to load GENERAL plugins automatically.
In addition to importing a file at startup, one can also run a single function inside a GENERAL plugin, and it will be passed the dbstate, the uistate, and the plugin data. The function must be called "load_on_reg", and take those three parameters, like this:
# file: library.py def load_on_reg(dbstate, uistate, plugin): """ Runs when plugin is registered. """ print "Hello World!"
Here, you could connect signals to the dbstate, open windows, etc.
Another example of what one can do with the plugin interface is to create a general purpose plugin framework for use by other plugins. Here is the basis for a plugin system that:
- allows plugins to list data files
- allows the plugin to process all of the data files
First, the gpr.py file:
register(GENERAL, id = "ID", category = "CATEGORY", load_on_reg = True, process = "FUNCTION_NAME", )
This example uses three new features:
- GENERAL plugins can have a category
- GENERAL plugins can have a load_on_reg function that returns data
- GENERAL plugins can have a function (called "process") which will process the data
If you (or someone else) create additional general plugins of this category, and they follow your load_on_reg data format API, then they could be used just like your original data. For example, here is an additional general plugin in the 'WEBSTUFF' category:
# anew.gpr.py register(GENERAL, id = 'a new plugin', category = "WEBSTUFF", version = '1.0', gramps_target_version = '3.4', data = ["a", "b", "c"], )
This doesn't have load_on_reg = True, nor does it have a fname or process, but it does set the data directly in the .gpr.py file. Then we have the following results:
>>> from gui.pluginmanager import GuiPluginManager >>> PLUGMAN = GuiPluginManager.get_instance() >>> PLUGMAN.get_plugin_data('WEBSTUFF') ["a", "b", "c", "Stylesheet.css", "Another.css"] >>> PLUGMAN.process_plugin_data('WEBSTUFF') ["A", "B", "C", "STYLESHEET.CSS", "ANOTHER.CSS"]
Registered GENERAL Categories
The following are the published secondary plugins API's (type GENERAL, with the following categories):
A sample gpr.py file:
# stylesheet.gpr.py register(GENERAL, id = 'system stylesheets', category = "WEBSTUFF", name = _("CSS Stylesheets"), description = _("Provides a collection of stylesheets for the web"), version = '1.0', gramps_target_version = '3.4', fname = "stylesheet.py", load_on_reg = True, process = "process_list", )
Here is the associated program:
# file: stylesheet.py def load_on_reg(dbstate, uistate, plugin): """ Runs when plugin is registered. """ return ["Stylesheet.css", "Another.css"] def process_list(files): return [file.upper() for file in files]
register(GENERAL, category="Filters", ... load_on_reg = True )
def load_on_reg(dbstate, uistate, plugin): # returns a function that takes a namespace, 'Person', 'Family', etc. def filters(namespace): print "Ok...", plugin.category, namespace, uistate # return a Filter object here return filters
Get translators to translate your addon into multiple languages
- Initialize and update the template.pot for your addon:
./make.py init NewProjectName
- Initialize a language for your addon (say French, fr):
./make.py init NewProjectName fr
- Update it from gramps and other addons:
./make.py update NewProjectName fr
- Compile the language:
./make.py compile NewProjectName
- Add or update your local language file, and commit changes:
svn add NewProjectName/po/fr-local.po
svn commit NewProjectName/po/fr-local.po -m "Added fr po file"
Package your addon
To create a downloadable package:
python make.py build NewProjectName
This will automatically include the following files in your build:
Starting with Gramp 5.0, if you have additional files beyond those listed above, you should create a MANIFEST file in the root of your addon folder listing the files (or pattern) one per line, like this sample MANIFEST file:
README.md extra_dir/* help_files/docs/help.html
Running the command make.py build will increment the third number in your dotted version number of all addons in the gpr.py file. Consider this number to be a "build number".
Then add the package to SVN:
svn add ../download/NewProjectName.addon.tgz cd .. svn commit -m "Message describing changes"
List your addon in the Gramps Plugin Manager
New for Gramps 3.4: You need to then make your addon available in listings of various languages.
Gramps needs to have been built
Make sure you have already built gramps34 or gramps41 or master
To create a listing:
cd gramps-addons/branches/gramps41/contrib # or wherever you have built your addon GRAMPSPATH=path/to/your/gramps/install python make.py listing NewProjectName
That will create a series of files in the ../listings/ directory.
Then add the updated listing to SVN:
svn add ../listings/* cd .. svn commit -m "Message describing changes"
List and document your addon on the wiki
Document the addon in the wiki using the name Addon:NewProjectName.
You can point to the addon.tgz in SVN or GIT as the downloadable file.
To build and compile translations for all projects to their download/Addon.addon.tgz files:
python make.py build all
To compile translations for all projects :
python make.py compile all
Support it through issue tracker
Visit https://gramps-project.org/bugs/view_all_bug_page.php and become a user. Suggest to check it regularly.
Maintain the code as Gramps continues to evolve
Remember that Gramps addons exist for many reasons and there are many Gramps developers that do support addons in various ways (translations, triage, keeping in sync with master, download infrastructure, etc).
Some reasons why the addons exist; they provide:
- A quick way for anyone to share their work; the Gramps-project has never denied adding a addon.
- A method to continuously update and develop a stand-alone component, often before being officially accepted.
- A place for controversial plugins that will never be accepted into core, but are loved by many users (eg, Data Entry Gramplet).
- A place for experimental components to live.
- Gramps Addons site for Gramps 4.2 and newer
- https://github.com/gramps-project/addons-source - Source code (Git)
- https://github.com/gramps-project/addons - downloadable .tgz files
- Gramps Addons site for Gramps 3.2 to Gramps 4.1.
- https://sourceforge.net/p/gramps-addons/ - Source code (SVN) and downloadable .tgz files