Changes

''{{man warn|Warning:|This page documents the API, methods, and best practices for developing an 3rda [[Third-party addon Addons|Third-party Addon]] for GRAMPS 3Gramps 4.2and later. For 4.2 and earlier, due March 2010see [[Addons_development_old]].''}}

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

The [http://github.com/gramps-project/addons-source addons-source] git repository has the following structure: * /addons-source** /''IndividualNameOfAddon1''** /''IndividualNameOfAddon2''** ... The [http://github.com/gramps-project/addons addons] git repository has the following structure: * /addons** /gramps42*** /download*** /listings** /gramps50*** /download*** /listings The '''addon-source''' repository holds the source code for the addons with branches holding the version for different gramps. If you are working on an addon for gramps for gramps42, be sure to use the gramps42 git branch, as the default is master branch (currently gramsp 5.x). Example commands are shown below. Once you have your addon working in one branch, (say gramps42), then you will also want to copy it to the other branch (master), after you have tested it to work properly and edited the '.gpr.py' file appropriately. === Get a local copy of Gramps and its addons === These steps show how to download the addon sources. # 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]] for instructions on installing git and getting basic settings configured. Also https://help.github.com/articles/generating-an-ssh-key/ will help with setting up credentials for GitHub.To fully build and advertise a new addon will require local copies of the three repositories, the 'addons-source', 'addons' and the main Gramps source 'gramps'. This wiki assumes that the three git repositories local locations are all to be put into the users' home directory and named with the repository names. The three directories '''must''' be named as shown, and in the same base directory in order for the make.py script to work properly, however they don't have to be located directory in the users home directory. From your home directory;  git clone [email protected]:gramps-project/addons-source.git addons-source git clone [email protected]:gramps-project/addons.git addons git clone [email protected]:gramps-project/gramps.git gramps or if you do not have a Github account:  git clone https://github.com/gramps-project/addons-source.git addons-source git clone https://github.com/gramps-project/addons.git addons git clone https://github.com/gramps-project/gramps.git gramps This will create a copy of the addons-source tree in your home directory at "~/addons-source", and the other trees at their respective locations as well. To switch to a local copy of the gramps42 branch:  cd addons-source git checkout -b gramps42 origin/maintenance/gramps42 or to work in the master branch:  cd addons-source git checkout -b gramps42 origin/master === Other pre-requisites ===* Gramps uses Python version 3.2 or higher. You must have at least that version installed. If you have installed Gramps 4.2 or higher on your Linux system already, then a sufficient version of Python will be present. If you have more than one version of Python installed, then you must use the correct version for these scripts. On some systems, both Python 2.x and 3.x are installed. It is possible that the normal invocation of <code>python</code> starts up Python 2.x, and that to start up Python 3.x requires invoking with <code>python3</code> or <code>python3.4</code> etc. You can test the version by <code>python –version</code> or <code>python3 –version</code>. If this is so, replace any usage of 'python' in the examples below with the appropriate invocation.* The make.py used in construction of the addons requires that the LANGUAGE environment variable be set to 'en_US.UTF-8'. * The make.py used in construction of the addons requires that the GRAMPSPATH environment variable be set to your path to the Gramps source tree.* intltool must be installed;: <code>sudo apt-get install intltool</code> For example if your home directory is '/home/name' and you use the suggested path names, use: <code>GRAMPSPATH=/home/name/gramps LANGUAGE='en_US.UTF-8' python3 make.py ...</code>to replace the <code>./make.py</code> in the examples below. === Create your addon subdirectory ===* Make a new project directory in addons-source:: <code>mkdir NewProjectName</code> ===Follow the development API for your tool===Create your NewProjectName.py and NewProjectName.gpr.py files. 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 development see [[Portal:Developers]] and [[Writing a Plugin]] specifically. === Test your addon as you develop ===To test your addon as you develop it is suggested that you insert your NewProjectName plugin into your Gramps user plugin directory with a link to your addon development toolsdirectory, like so:  cd ~/.gramps/gramps42/plugins ln -s ~/addons-source/NewProjectName NewProjectName Your installed Gramps will search this folder (and subdirectories) for .gpr.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 see your addon source. * Remove the files that should not be added to GitHub:: <code>./make.py gramps42 clean NewProjectName</code>* Add the project to the repository:: <code>git add NewProjectName</code>* Commit it with an appropriate message: <code>git commit -m "A message describing what this addon is"</code> Before committing additional edits to your addon, you should: * to make sure that outside changes do not affect your commit: <code>git pull --rebase</code>* only the files you changed should be in this list: <code>git status</code>* Commit it with an appropriate message: <code>git commit -m "A message describing the changes"</code> If you have been given 'push' rights to GitHub 'gramps-project/addons-source', and when you are sure you are done and want to publish to the repository: * to make sure that outside changes do not affect your commit: <code>git pull --rebase</code>: <code>git push origin gramps42</code> Also you may want to [[Addons_development#Package_your_addon |Package your addon]] so it can be downloaded via the plugin manager. === Config ===

# Checkout the gramps-Some addons files from the [https://sourceforge.net/projects/gramps-addons/ gramps-addons] project:## cd may want to the same director have persistent data (data settings that gramps trunk is in ## svn co https://gramps-addons.svnremain between sessions).sourceforge.net/svnroot/grampsYou can handle this yourself, or you can use Gramps' built-addons gramps-addons## cd gramps-addons# Make a new project directory in gramps-addon/contrib:## cd contrib## mkdir NewProjectName# Initialize the addon:## ./makeconfigure system.py init NewProjectName

Follow At the development API for your tool, [[Report-writing_tutorial|report]], view, or [[Gramplets]]. Place all top of the source file of your associated .py, .gladeaddon, etc. files in you would do this directory. For general information on GRAMPS development see [[Portal:Developers]] and [[Writing a Plugin]] specifically.

To test your addon from config import config as you develop 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 is suggested that you replace your GRAMPS user plugin directory with a link to your addon development directory, like socase it didn't exist: config.save()

cd ~/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.gramps/ mv plugins/* /wherever/gramps-addons/contrib/ rm -rf plugins ln -s /wherever/gramps-addons/contrib plugins

GRAMPS will search this folder (and subdirectories) for .grp.py filesIn the addon, and add them to the plugin list.you can then:

If you have code that you want to share between addons, you don't need to do anything special x = config. Currently, GRAMPS adds each directory in which a get("section.gproption-name1") config.py is found onto the PYTHONPATH which is searched when you perform an importset("section. Thus option-name1"import NewProjectName" will work from another addon. You should always make sure you name your addons with a name appropriate for Python imports., 3)

To commit your changes so and when this code is exiting, you might want to save the config. In a Gramplet that others can use your addon, follow these stepswould be:

# Get an http def on_save(self)://sourceforge.net account if you don't already have one.# Request SVN write access for the gramps-addon project from https://sourceforge config.net/project/memberlist.php?group_id=285429# 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"save()

Before making additional edits to If your addoncode is a system-level file, then you shouldmight want to save the config in the Gramps system folder:

# svn update 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# svn status config = configman.get_manager("grampletname")# svn commit x = config.get("section.option-m "A message describing the changesname1")

from TransUtils import get_addon_translatorregister(PTYPE, gramps_target_version = "4.2",_ version = get_addon_translator(__file__"1.0.0", ATTR = value,).gettext

Then you can use the standard "_()" function to translate phrases in your addon[https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/_pluginreg.py#L76 PTYPE] is TOOL, GRAMPLET, 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 = '4.02', status = UNSTABLESTABLE,

You can see examples of the kinds of addons [httphttps://gramps.svn.sourceforgegithub.netcom/viewvcgramps-project/gramps/trunk/src/plugins/ here] (for example, see [httphttps://gramps.svn.sourceforgegithub.netcom/viewvcgramps-project/gramps/trunk/src/plugins/drawreport/drawplugins.gpr.py?revision=13424&view=markup trunk/srcgramps/plugins/drawreport/*drawplugins.gpr.py]) and see the full documentation [httphttps://gramps.svn.sourceforgegithub.netcom/viewvcgramps-project/gramps/trunkgen/srcplug/_pluginreg.py 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 viewon 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 = '4.2', status = STABLE, fname = 'library.py', load_on_reg =markup 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, hereis 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 = '5.0', 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 comments and docstrings.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 = '5.0', 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 ====

Note that this For example: <pre>register(GENERAL, category="Filters", ..gpr.py will automatically use translations if you have them load_on_reg = True)</pre> <pre>def load_on_reg(see belowdbstate, uistate, plugin). That is: # returns a function that takes a namespace, the function "_" is predefined to use your locale translations; you don't have to do anything. For examplePerson', in the above example'Family', _etc.  def filters(namespace): print "Attach SourceOk...") is marked for translation, plugin. If you have developed and packaged your addon with translation supportcategory, then that phrase will be converted into the user's language.namespace, uistate # return a Filter object here return filters</pre>

# * Initialize and update the template.pot for your addon:## : <code>cd ~/addons-source</code>: <code>./make.py gramps42 init NewProjectName</code># * You should edit the header of template.pot with your information, so it gets copied to individual language files.* Initialize a language for your addon (say French, fr):## : <code>./make.py gramps42 init NewProjectName fr</code># * Update it from gramps and other addons:## : <code>./make.py gramps42 update NewProjectName fr</code># * Edit contribthe translations file manually:: <code>/NewProjectName/po/fr-local.po</code># * Compile the language:## : <code>./make.py gramps42 compile NewProjectName fr</code># * Add or update your local language file, and commit changes:## svn : <code>git add NewProjectName/po/fr-local.po</code>## svn : <code>git commit NewProjectName/po/fr-local.po -m "Added fr po file"</code>* If you have been given 'push' rights to GitHub 'gramps-project/addons-source', then;: <code>git push origin gramps42</code>

: <code>./make.py gramps42 build NewProjectName</code> or: <code>./make.py gramps50 build NewProjectName</code> for the master branch. Note that the  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 xxx 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".}} This will leave your 'addons-source' with untracked changes according to git. You should delete the 'NewProjectName/locale' directory. The updated 'NewProjectName/NewProjectName.gpr.py ' is ready to add and commit the next time you make other changes.: <code>rm –rf –v 'NewProjectName/locale'</code> Then add the package to GitHub:  <pre> cd '~/addons' git add gramps42/download/NewProjectName.addon.tgz git commit -m "Added new plugin: NewProjectName"</pre>or (for the master branch);<pre> cd '~/addons' git add gramps50/download/NewProjectName.addon.tgz git commit -m " Added new plugin: NewProjectName"</pre>  == List your addon in the Gramps Plugin Manager== {{man warn|Gramps needs to have been built|Make sure you have already built gramps42 or master. Change to the appropriate git branch in your gramps directory, and run 'python3 setup.py build' See [[Linux:Build_from_source]]}} To create a listing: : <code>cd '~/gramps-addons'</code> or wherever you have built your addon: <code>GRAMPSPATH=path/to/your/gramps/install ./make.py gramps42 listing NewProjectName</code>or (for the master branch);: <code>cd '~/gramps-addons'</code> or wherever you have built your addon: <code>GRAMPSPATH=path/to/your/gramps/install ./make.py gramps50 listing NewProjectName</code> That will create a series of files in the <tt>../listings/</tt> directory. Then add the updated listing to GitHub: <pre> cd '~/addons' git add gramps42/listings/* git commit -m "Added new plugin to listings: NewProjectName"</pre>or (for the master branch);<pre> cd '~/addons' git add gramps50/listings/* git commit -m " Added new plugin to listings: NewProjectName"</pre> == List and document your addon on the wiki== Document the addon in the wiki using the name {{man menu|Addon:NewProjectName}}.

svn add download/NewProjectName.You can point to the addon.tgzin GitHub as the downloadable file.

== List and document your addon Miscellaneous commands ==

Edit [[3.2 Third-party Plugins]] To build and describe your addoncompile translations for all projects to their download/Addon. You can point to the addon.tgz in SVN as the downloadable filefiles: : <code>python3 make. Document the addon in the wiki using the name "Addonpy gramps42 build all</code> To compile translations for all projects : :NewProjectName"<code>python3 make.py gramps42 compile all</code>

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]]