Changes

''{{out of date}}{{man warn|Warning:|This page documents the API, methods, and best practices for developing an a 3rd-party addon for GRAMPS Gramps 3.2, due March 2010.''and later }}

Addon's for GRAMPS can extend the program in many different ways. You can add any of the following types of addons:#Report# Doc creatorQuickreport# ExporterTool# GrampletImporter# ImporterExporter# Map serviceDoc creator# Plugin lib# QuickreportMap service# RelationshipsGramps View# ReportRelationships# ToolGramplet# ViewSidebar

# Support it through the issue tracker# Maintain the code as GRAMPS Gramps continues to evolve

# {{man tip| 1=Tip |2=To use make.py as shown throughout this document, you may have to use:<br /><pre>GRAMPSPATH=/path/to/gramps python make.py ...</pre> <br /> if the default ("../../..") is not correct.}} * Checkout the gramps-addons files from the [https://sourceforge.net/projects/gramps-addons/ gramps-addons] project:## ** cd into gramps trunk, for example:### *** <pre>cd ~/gramps/trunk</pre>## ** Checkout gramps-addons:### *** <pre>svn co https://gramps-addonssvn.svncode.sourceforgesf.net/svnrootp/gramps-addons /code gramps-addons</pre>## ** Change to that trunk or branches/gramps41 directory:### *** <pre>cd gramps-addons/branches/gramps41/contrib</pre># * Make a new project directory in gramps-addon/branches/gramps41/contrib:## cd contrib## ** <pre>mkdir NewProjectName</pre># * Initialize the addon:## ** <pre>./make.py init NewProjectName</pre>

===Follow the development API for your tool===Follow the development API for your tool, [[Report-writing_tutorial|report]], view, or [[Gramplets]]. Place all of your associated .py, .glade, etc. files in this directory. For general information on GRAMPS 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 Gramps user plugin directory with a link to your addon development directory, like so:

cd ~/.gramps/gramps32gramps41/ mv plugins/* /wherever/trunk/gramps-addons/branches/gramps41/contrib/

ln -s /wherever/trunk/gramps-addons/branches/gramps41/contrib plugins

GRAMPS 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 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:

# 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 httpshttp://sourceforge.net/projectprojects/gramps-addons/memberlist.php?group_id=285429

## <pre>./make.py clean NewProjectName</pre>

## <pre>svn add NewProjectName</pre>## <pre>svn commit -m "A message describing what this addon is"</pre>

# <pre>svn update</pre># <pre>svn status</pre># <pre>svn commit -m "A message describing the changes"</pre> Also you may want to [[Addons_development#Package_your_addon |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 [[Contact#Mailing_lists|gramps-devel mailing list]]See also [[Brief_introduction_to_Git|git introduction]].  git clone [email protected]: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

In At the top of the source file that defines the settingsof your addon, you would do this:

from config import configas configman cm config = configconfigman.register_manager("view_placetreeview_0grampletname") cm# register the values to save: config.register("section.variable1option-name1", value1) cmconfig.register("section.variable2option-name2", value2)

cm# load an existing file, if one: config.initload() # 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.

This will create the file "view_placetreeview_0.ini" and put in the same directory as the addon. In the addon, you can then:

x = cmconfig.get("section.variable1option-name1") cmconfig.set("section.variable1option-name1", 3)

cmconfig.save() If your code is a system-level file, then you might want to save the config in the Gramps system folder:

If your code is a config = configman.register_manager("system plugin", then you might want to save the config in the Gramps system folder:use_config_path=True)

cm = configThis, however, would be rare; most .ini files would go into the plugins directory.register_manager("view_placetreeview_0", use_config_path=True)

from config import configas configman cm config = configconfigman.get_manager("view_placetreeview_0grampletname") x = cmconfig.get("section.variable1option-name1")

Then you can use the standard "_()" function to translate phrases in your addon.

# gettext

# ngettextsgettext Gramps 3 also provides: 

NOTE: currently we donThese have become obsolete in Gramps 4;t have a method of using a context gettext, ngettext, and sgettext always return translated strings in any of these functionsunicode for consistent portability between Python 2 and Python3.

See the [http://docs.python.org/3/library/gettext.html#the-gnutranslations-class python documentation] for documentation of gettext and ngettext. The translation functions that "l" versions return the string encoded according to the [http://docs.python.org/3/library/locale.html#locale.setlocale currently set locale]; the "u" versions return unicode strings in Python2 and are supported are defined as followsnot available in Python 3.

==== gettext'''sgettext''' is a Gramps extension that filters out clarifying comments for translators, such as _(message"Remaining names | rest") ====Where "rest" is the English string that we want to present and "Remaining names" is a hint for translators.

If == Create a fallback has been set, forward gettext() to the fallback. Otherwise, return the translated message. Overridden in derived classes.Gramps Plugin Registration file ==

If a fallback has been set, forward lgettext<pre>register() to the fallback. OtherwisePTYPE, return the translated message. Overridden in derived classes.  gramps_target_version ==== ugettext(message) ==== If a fallback has been set, forward ugettext() to the fallback"3. Otherwise4", return the translated message as a Unicode string. Overridden in derived classes.  version ==== ngettext(singular, plural, n) ==== If a fallback has been set, forward ngettext() to the fallback"1.0. Otherwise0", return the translated message. Overridden in derived classes.  ATTR ==== lngettext(singularvalue, plural, n) ==== If a fallback has been set, forward ngettext() to the fallback. Otherwise, return the translated message. Overridden in derived classes.</pre>

==== ungettext(singular[http://sourceforge.net/p/gramps/source/ci/master/tree/gramps/gen/plug/_pluginreg.py#l78 PTYPE] is TOOL, pluralGRAMPLET, n) ====REPORT, QUICKVIEW, IMPORT, EXPORT, DOCGEN, GENERAL, MAPSERVICE, VIEW, or RELCALC.

== Create 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 Plugin Registration file ==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.

First, create the NewProjectName.gpr.py file. Here is a sample Tool GPR file:

version = '1.0.0', gramps_target_version = '3.04', status = UNSTABLESTABLE,

You can see examples of the kinds of addons [http://gramps.svn.sourceforge.net/viewvcp/gramps/trunksource/ci/master/tree/srcgramps/plugins/ here] (for example, see [http://gramps.svn.sourceforge.net/viewvcp/gramps/trunksource/ci/srcmaster/tree/gramps/plugins/drawreport/drawplugins.gpr.py?revision=13424&view=markup trunkgramps/source/ci/master/tree/srcgramps/plugins/drawreport/*drawplugins.gpr.py]) and see the full documentation [http://gramps.svn.sourceforge.net/viewvcp/gramps/trunksource/ci/master/tree/srcgramps/gen/plug/_pluginreg.py?view=markup 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. === Report plugins ===The possible report categories are (gen/plug/_pluginreg.py):<pre>#possible report categoriesCATEGORY_TEXT = 0CATEGORY_DRAW = 1CATEGORY_CODE = 2CATEGORY_WEB = 3CATEGORY_BOOK = 4CATEGORY_GRAPHVIZ = 5REPORT_CAT = [ CATEGORY_TEXT, CATEGORY_DRAW, CATEGORY_CODE, CATEGORY_WEB, CATEGORY_BOOK, CATEGORY_GRAPHVIZ]</pre> 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. === General plugins === 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): <pre># 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, )</pre> 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: <pre># file: library.py def load_on_reg(dbstate, uistate, plugin): """ Runs when plugin is registered. """ print "Hello World!"</pre> 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: <pre> register(GENERAL, id = "ID", category = "CATEGORY", load_on_reg = True, process = "FUNCTION_NAME", )</pre> 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: <pre># anew.gpr.py register(GENERAL, id = 'a new plugin', category = "WEBSTUFF", version = '1.0', gramps_target_version = '3.4', data = ["a", "b", "c"], )</pre> 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: <pre>>>> 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"]</pre> === Registered GENERAL Categories === The following are the published secondary plugins API's (type GENERAL, with the following categories): ==== WEBSTUFF ==== A sample gpr.py file: <pre># 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", )</pre> Here is the associated program: <pre># 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]</pre> ==== Filters ==== For example: <pre>register(GENERAL, category="Filters", ... load_on_reg = True)</pre> <pre>def load_on_reg(dbstate, uistate, plugin): # returns a function that takes a namespace, 'Person', 'Family', etc.

Note that this def filters(namespace): print "Ok.gpr.py will automatically use translations if you have them (see below). That is", the function "_" is predefined to use your locale translations; you don't have to do anythingplugin. For examplecategory, in the above examplenamespace, _("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.uistate # return a Filter object here return filters</pre>

# * Initialize and update the template.pot for your addon:## ** <pre>./make.py init NewProjectName</pre># * Initialize a language for your addon (say French, fr):## ** <pre>./make.py init NewProjectName fr</pre># * Update it from gramps and other addons:## ** <pre>./make.py update NewProjectName fr</pre># * Edit <pre>contrib/NewProjectName/po/fr-local.po</pre># * Compile the language:## ** <pre>./make.py compile NewProjectName fr</pre># * Add or update your local language file, and commit changes:## ** <pre>svn add NewProjectName/po/fr-local.po</pre>## ** <pre>svn commit NewProjectName/po/fr-local.po -m "Added fr po file"</pre>

python make.py build NewProjectName This will automatically include the following files in your build: * *.py* *.glade* *.xml* *.txt* locale/*/LC_MESSAGES/*.mo 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:  <pre>README.mdextra_dir/*help_files/docs/help.html</pre> {{man note|Note:|Running the command '''make.py build NewProjectName''' 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".}}

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.  {{man warn|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 <tt>../listings/</tt> 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 {{man menu|Addon:NewProjectName}}. Edit [[Plugins3.4]] or [[4.2_Addons]] and describe your addon.  You can point to the addon.tgz in SVN or GIT as the downloadable file. == Miscellaneous commands == To build and compile translations for all projects to their download/Addon.addon.tgz files:  python make.py build all

Edit [[3.2 Third-party Plugins]] and describe your addon. You can point to the addon.tgz in SVN as the downloadable file. Document the addon in the wiki using the name "Addon:NewProjectName" python make.py compile all

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 Gramps continues to evolve == Remember that Gramps addons exist for many reasons and there are manyGramps 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.

* http[[Category:Developers/General]][[Category:Developers/gramps-addons.svn.sourceforge.net/viewvc/gramps-addons/ - SVN browseTutorials]][[Category:Plugins]][[Category:Reports]][[Category:Gramplets]][[Category:Addons]]