4,216
edits
Changes
→Get a local copy of Gramps and its addons
= Addon Development =What can addons extend?==Addons for Gramps can extend the program in many different ways. You can add any of the following [https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/_pluginreg.py types] of addons:
==Writing an addon==
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|Develop your addon]]# [[#Create_a_Gramps_Plugin_Registration_file|Create a Gramps Plugin Registration file (.gpr.py)]]# Get translators to translate [[#internationalization|Invite translation of your addon ]] into multiple natural languages# [[#Package_your_addon|Package your addon]]# List [[#List_and_document_your_addon_on_the_wiki|Document your addon]] and document publish it to the addon list# [[#List_your_addon_in_the_Gramps_Plugin_Manager|Register your addonwith the Plugin Manager]]# [[#Announce_the_addon|Announce it on the Gramps Forum]] - Let users know it exist and how to use it.# [[#Support_it_through_issue_tracker|Support it through the issue tracker]]# [[#Maintain_the_code_as_Gramps_continues_to_evolve|Maintain the code ]] as GRAMPS Gramps continues to evolve
We'll now look at expand upon each of these steps in detailindividually.
== Develop your addon ==
The [http://github.com/gramps-project/addons subversion -source addons-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 the current Gramps {{man version}} public release, be sure to use the maintenance/gramps52 git branch, as the default is master branch for the developmental pre-release. (Currently gramps 5.3, which is not the typical target for addons.) Example commands are shown below referring to the public release rather than the master branch. The developers are currently merging changes to the most recent maintenance branch into master as necessary, so you don't have to do anything for that unless you are in a hurry. The [http://github.com/gramps-project/addons-source addons-source] git repository has the following structure, with the code for each addon in its own folder:
* /addons-source** /''IndividualNameOfAddon1''** /''IndividualNameOfAddon2''** ... The [http://github.com/gramps-project/addonsaddons] git repository holds built versions of the addons for each release of Gramps, and has the following structure: ** /trunkaddons*** [https://github.com/gramps-project/addons/tree/master/gramps42 /contribgramps42]
*** /download
*** /brancheslistings** [https://github.com/gramps-project/addons/tree/master/gramps50 /gramps50]*** /gramps32download*** /listings** [https://github.com/gramps-project/addons/tree/master/gramps51 /contribgramps51]*** /download*** /listings** [https://github.com/gramps-project/addons/tree/master/gramps52 /gramps52]*** /download*** /listings
These steps show how to download and work with the addon development toolssources.
# Checkout the gramps-addons files from the [Get an https://sourceforgegithub.netcom/projects/gramps-addons/ gramps-addons] project:join account if you don't already have one.## cd into gramps trunk, Request GIT write access for examplethe https:### cd ~//github.com/gramps-project/trunkaddons-source project by emailing the [[Contact## Checkout Mailing_lists|gramps-addons:devel mailing list]]### svn co See also [[Brief_introduction_to_Git|git introduction]] for instructions on installing git and getting basic settings configured. Also [https://gramps-addonshelp.svngithub.sourceforge.netcom/svnrootarticles/grampsgenerating-addons grampsan-addons## Change to trunk or branches/gramps32 directory:### cd grampsssh-addonskey/branches/gramps32/contrib Connecting to GitHub with SSH] will help with setting up credentials for GitHub.# Make To fully build and advertise a new project directory in grampsaddon will require local copies of the three repositories, the 'addons-addon/branches/gramps32/contrib:## mkdir NewProjectName# Initialize source', 'addons' and the addon:## ./makemain Gramps source 'gramps'.py init NewProjectName
=== Config ===
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.
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)
...
x = cmconfig.get("section.variable1option-name1") cmconfig.set("section.variable1option-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):
If your code is a system-level file, then you might want to save the config in the Gramps system folder:
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 configas configman cm config = configconfigman.get_manager("view_placetreeview_0grampletname") x = cmconfig.get("section.variable1option-name1")
=== Localization ===
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.
Note that these instructions will only work for Python strings, if you have a glade file, it will not get translated.
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:
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:
# gettext
# lgettext
# ngettext
# lngettext
# ngettext# ugettext# ungettext NOTE: currently we don;t have a method of using a context in any of these functions. The translation functions that are supported are defined as follows. ==== gettext(message) ==== If a fallback has been set, forward gettext() to the fallback. Otherwise, return the translated message. Overridden in derived classes. ==== lgettext(message) ==== If a fallback has been set, forward lgettext() to the fallback. Otherwise, return the translated message. Overridden in derived classes.sgettext
== Create a Gramps Plugin Registration file ==
<pre>
register(PTYPE,
gramps_target_version = "35.2",
version = "1.0.0",
ATTR = value,
</pre>
[https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/_pluginreg.py#L76 PTYPE ] is TOOL, GRAMPLET, REPORT, QUICKREPORTQUICKVIEW, 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:
description = _("Attaches a shared source to multiple objects."),
version = '1.0.0',
gramps_target_version = '35.2', status = UNSTABLESTABLE,
fname = 'AttachSourceTool.py',
authors = ["Douglas S. Blank"],
</pre>
You can see examples of the kinds of addons [httphttps://grampsgithub.svn.sourceforge.netcom/viewvcgramps-project/gramps/trunk/src/plugins/ here] (for example, see [httphttps://grampsgithub.svn.sourceforge.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 in the [httphttps://github.com/gramps.svn.sourceforge.net-project/gramps/blob/viewvc3f0db9303f29811b43325c30149c8844c7ce24b6/gramps/trunkgen/plug/src_pluginreg.py#L23 master/gramps/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 ([https://github.com/gramps-project/gramps/blob/892fc270592095192947097d22a72834d5c70447/gramps/gen/plug/_pluginreg.py#L141-L149 gen/plug/_pluginreg.py]):
<pre>
#possible report categories
CATEGORY_TEXT = 0
CATEGORY_DRAW = 1
CATEGORY_CODE = 2
CATEGORY_WEB = 3
CATEGORY_BOOK = 4
CATEGORY_GRAPHVIZ = 5
CATEGORY_TREE = 6
REPORT_CAT = [ CATEGORY_TEXT, CATEGORY_DRAW, CATEGORY_CODE,
CATEGORY_WEB, CATEGORY_BOOK, CATEGORY_GRAPHVIZ, CATEGORY_TREE]
</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|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 = '5.2',
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 = '5.2',
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 = '5.2',
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.
def filters(namespace):
print("Ok...", plugin.category, namespace, uistate)
# return a Filter object here
return filters
</pre>
<span id=internationalization>
== List the Prerequistes your addon depends on ==
''In your gpr file, you can have a line like:
<code>depends_on = ["libwebconnect"]</code>
which is a list of id's from other gpr files. This example will ensure that [[Addon:Web_Connect_Pack#Prerequisites|libwebconnect]] is loaded before your addon. If it can't be found, or you have a cycle, then your addons won't be loaded.
example code used in the Addon:Web_Connect_Pack that references libwebconnect Prerequistes [https://github.com/gramps-project/addons-source/blob/1304b65a7d758bfe17339c26260473ac3e9c4061/RUWebConnectPack/RUWebPack.gpr.py#L17 RUWebPack.gpr.py#L17 ]
This means that common Prerequistes can be shared between addons and that code sits in its own gpr/addon file.
<!--
[] for addon prerequistes have a look at converting them to use "depends_on = " like in the following addons
https://github.com/gramps-project/addons-source/search?utf8=%E2%9C%93&q=depends_on&type=
https://github.com/gramps-project/gramps/search?utf8=%E2%9C%93&q=depends_on&type=
which can be a comma separated list for multiple dependencies/prerequisites (so that addons that share prerequisites import the same library?) (maybe move spell check into an addon etc? tip of the day... possibilities...)
depends_on = ["libwebconnect"]
mentioned in the following
https://sourceforge.net/p/gramps/mailman/message/27070037/
''In your gpr file, you can have a line like:
depends_on = ["libwebconnect"]
which is a list of id's from other gpr files. This example will ensure
that libwebconnect is loaded before your plugin. If it can't be found,
or you have a cycle, then your plugin won't be loaded.
If it is a common function, perhaps libhtml is the right place to put
it, and you can put a depends_on on that.
-Doug''
example output is on terminal only:
Cannot resolve the following plugin dependencies:
Plugin 'UK Web Connect Pack' requires: ['libwebconnect']
[](feature) For plugins/addons if prerequisites not available display a page stating why/what is missing that includes the addon description and a url to the support page.
[] Gramps CLI info "gramps -v" needs a section that list third-party addons with version numbers and if prerequisites have been met.
[]update the Addon:Prerequisites Checker Gramplet to test for your Prerequisites.
-->
== Get translators to translate your addon into multiple languages ==
</span>If you [[# Localization|designed for localization]], the addon will begin supporting a single language. Make your addon inviting for volunteers to translate it into their native language.* Initialize and update the <code>template.pot </code> for your addon:## : <code>cd ~/addons-source</code>: <code>./make.py gramps52 init NewProjectName</code>* You should edit the header of <code>template.pot</code> with your information, so it gets copied to individual language files.# * Initialize a language for your addon (say French, fr):## : <code>./make.py gramps52 init NewProjectName fr</code># * Update it from gramps and other addons:## : <code>./make.py gramps52 update NewProjectName fr</code># * Edit contribthe translations file manually:: <code>/NewProjectName/po/fr-local.po</code># * Compile the language:## : <code>./make.py gramps52 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 gramps52</code>
== Package your addon ==
To create a downloadable package:
: <code>./make.py gramps52 build NewProjectName</code> or: <code>./make.py gramps53 build NewProjectName</code> for the master branch. 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 <code>make.py xxx build</code> will increment the third number in your dotted version number of all addons in the <code>*.gpr.py</code> 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 gramps52/download/NewProjectName.addon.tgz git commit -m "Added new plugin: NewProjectName"</pre>or (for the master branch);<pre> cd '~/addons' git add gramps53/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 gramps52 or master. Change to the appropriate git branch in your gramps directory, and run <code>python3 setup.py build </code> 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 gramps52 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 gramps53 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 gramps52/listings/* git commit -m "Added new plugin to listings: NewProjectName"</pre>or (for the master branch);<pre> cd '~/addons' git add gramps53/listings/* git commit -m " Added new plugin to listings: NewProjectName"</pre> == List and document your addon on the wiki== ===List your addon===Add a short description of your addon to the Addons list by editing the current release listing eg: [[5.2_Addons]] or if the addon is meant for a future release [[5.3_Addons]] when available. ==== Example addon template ====Examine the listing for other addons and refer to the [[Addon list legend]] for details of on the meaning of each columns.<pre>|- <!-- Copy this section and list your Addon -->|<!-- Plugin / Documentation -->|<!-- Type -->|<!-- Image -->|<!-- Description -->|<!-- Use -->|<!-- Rating (out of 4) -->|<!-- Contact -->|<!-- Download -->|-</pre> ===Document your addon===Document the addon in the wiki using the page name format of {{man menu|Addon:NewProjectName}} examine the other addon support pages for the general format to use.{{man tip|Hint on creating a new wiki page.|To create a new wiki page use the search box to search for the name of your page that doesn't exist then on the search results page you will be provided with a link to create the new page, by selecting and you can add your content}} ====Example addon article====Consider including the following information: <pre><!-- Copy this section to your Addon support page-->{{Third-party plugin}}<!-- This is a mediawiki template that expands out to display the standard addon message you see at the top of each addon page--> <!--sections only add if needed-->== Usage == === Configure Options ===
== List and document your addon Issues ==
== Support it through issue tracker ==
Become a user on the [https://gramps-project.org/bugs/view_all_bug_page.php Gramps MantisBT (Mantis BugTracker)]. and please check it regularly. There is no automated notification of issues (and possible feature requests) related to your addon when reported by users. Users tend to not understand coding and they make assumptions. So be kind and guiding if a report is ambiguous or inaccurate. A negative remark from an addon developer or anyone can be very discouraging. == Maintain the code as GRAMPS Gramps continues to evolve == {{man tip|When submitting an update the patch part of the version number MAJOR.MINOR.PATCH is updated during the addon build process e.g. 1.1.3 to 1.1.4|You can find this step in [https://github.com/gramps-project/addons-source/blob/master/make.py#L125 addons-source/make.py].[https://gramps.discourse.group/t/should-addons-pr-include-version-number-update/2591]}} 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. == Example code adding common enhancements ==* Copy all the Gramplet's output to a system clipboard via context pop-up menu : Enhancement request {{bug|11573}}, [https://github.com/gramps-project/gramps/pull/1014/commits/72012e13b4ca15caca4b7f36fdb9702c1fd470fd example pull]* add a custom [[Gramps_Glossary#viewmode|View Mode]] toolbar icon via the <code>.gpr.py</code> : [https://github.com/gramps-project/gramps/pull/1017 Pull 1017 Discussion], [https://github.com/gramps-project/gramps/pull/1017/commits/76e41d546d6ec519dd78fbe07f663135b5c79351 example Pull]
= Resources =
* [[Brief_introduction_to_Git|Git introduction]]
* [[Getting started with Gramps development]]
* [[Portal:Developers]]
* [https://gramps-project.org/docs/gen/gen_plug.html?highlight=include_in_listing#module-gramps.gen.plug._pluginreg Registration Module]
;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 4.1 and older
* For 4.1.x and earlier, see [[Addons development old]].
= Addon Development Tutorials and Samples =
* [[Report-writing_tutorial|Report-writing Tutorial]]
* [[Quick_Views|Quick Views]]
* [[Gramplets|Gramplets]]
* [[Develop_an_Add-on_Rule|Develop an Add-on Rule]]
* [[Develop_an_Add-on_Tool|Develop an Add-on Tool]]
* [[Adapt_a_built-in_Report|Adapt a built-in Report]]
