Third-party Addons
Third-party plugins give you more tools to work with your genealogy data in GRAMPS. This page lists plugins written by users to work with the 3.1.x series version of GRAMPS, released in March 2009.
Plugins for the previous version: 3.0.x Third-party Plugins page.
Please Note: These plugins may not be officially part of GRAMPS. Feature requests and bugs with these plugins should be directed to the contact information below. |
Contents
Installing Plugins in GRAMPS
To install a GRAMPS Plugin:
- click on the download link below
- if the download is a file that ends in .py, save it in your GRAMPS User Directory, in the plugins folder
- if the download is a file that ends in .zip or .gz, save the contents of the file in your GRAMPS User Directory, in the plugins folder
- restart gramps, OR reload the plugins from the Help -> Plugin Status -> Reload button.
The Plugin Status window will show you which plugins failed to load, double click on such an entry shows you the error. You can mail this error to the plugin contact.
Plugin List
Every plugin listed below should have a Version number (so one can tell if and when it changes in the future), and also specify what version of GRAMPS it was written for. The Rating should give an indication of the state of the plugin:
- 0 Stars - initial version, basic framework defined, doesn't work correctly, please help
- 1 Star - partially working with some functionality, but much more work is needed; needs testing
- 2 Stars - about half done, works, but more work is needed for it to be complete; needs more testing
- 3 Stars - some known issues, but mostly complete
- 4 Stars - complete, works well, fully tested
The Use indicates who might make the most out of the plugin. Common categories of users:
- All
- Developer
- Beginning user
- Expert user
- Example
The plugins:
Third-party plugins give you more tools to work with your genealogy data in Gramps.
This page lists plugins written by users and developers to work with the Gramps 4.1 version.
These plugins may not be officially part of Gramps. Feature requests and bugs with these plugins should be directed to the contact information below.
Plugins for previous versions of Gramps can be found on the following pages
Installing Addons in Gramps
Gramps 3.3 introduced a new system for downloading and uploading Addons. Now you can have Gramps manage the process of checking and downloading updates.
To configure Gramps for Addons:
- Start Gramps
- Select Menu Edit -> Preferences...
- Go to the General tab
- Change "Check for updates" so when you start Gramps, it checks for updated Addons:
- Never - never checks for updates when you start Gramps
- Once a month - checks for updates when you start Gramps once a month
- Once a week - checks for updates when you start Gramps once a week
- Once a day - checks for updates when you start Gramps once a day
- Always - checks for updates whenever you start Gramps
- Change "What to check" so when you check for updates, it checks for:
- Updated addons only - does not check for new addons
- New addons only - does not check for updated addons
- New and updated addons - checks for all new and updated addons
- Change "Do not ask about previously notified addons":
- Check it so that new/updated addons are only asked about once; afterwards it doesn't show them to you
- Uncheck it so that new/updated addons are always shown to you
Writing a Plugin
- See Writing a Plugin for information on developing your own addon.
Addon List
Addons now are listed inside of Gramps through the interface described above.
See Plugin list legend for details of columns.
Plugin / Documentation | Type | Image | Description | Use | Rating (out of 4) | Contact | Download |
---|---|---|---|---|---|---|---|
All Names Quickview | Quickview | Shows all names for all people | All | 4 | Doug Blank | AllNamesQuickview.addon.tgz | |
AttachSourceTool | Tool | A tool to attach a source to a group of people. | All | 1 | Doug Blank | AttachSourceTool.addon.tgz | |
BirthdaysGramplet | Gramplet | Display the upcoming birthdays | All | 1 | Peter Potrowl | BirthdayGramplet.addon.tgz | |
Cairo Clock Gramplet | Gramplet | A sample Cairo clock gramplet. | Developer | 1 | Doug Blank | ClockGramplet.addon.tgz | |
Calculate Estimated Dates | Tool | A tool to set estimated birth and death dates. | All | 2 | Doug Blank | CalculateEstimatedDates.addon.tgz | |
Census Gramplet | Gramplet | Lists census events for the active person. Allows users to create and edit census data in a single form. | Expert user | 3 | Nick Hall | Census.addon.tgz | |
Census Report | Report | N/A | Prints census events in a format similar to the original census entries. | All | 3 | Nick Hall | Census.addon.tgz |
ClipboardGramplet | Gramplet | Allows one to group items together for quick access. | All | 2 | Doug Blank | ClipboardGramplet.addon.tgz | |
Command Line Merge | Tool | N/A | Merge primary object via the command line. | Developer | 3 | Michiel D. Nauta | CliMerge.addon.tgz |
D3 Ancestral/Descendant Charts | Web Report | Create ancestral/descendant web based interactive D3 charts. | All | 3 | Matt Keenan | D3Charts.addon.tgz | |
Data Entry Gramplet | Gramplet | Quick Data Entry for People data | Expert user | 4 | Gramps Bugtracker | DataEntryGramplet.addon.tgz | |
Deep Connections Gramplet | Gramplet | Finds deep relationships between home and active people | All | 3 | Gramps Bugtracker | DeepConnectionsGramplet.addon.tgz | |
DenominoViso | Web report | Creates interactive graphical ancestor/descendant tree on a webpage. | All | 3 | Michiel Nauta | DenominoViso.addon.tgz | |
Descendant and Detailed Descendant Book Reports | Report | Create a book of descendant or detailed descendant reports using a filter. | All | 2 | Matt Keenan | DescendantBooks.addon.tgz | |
Descendant Count Gramplet | Gramplet and Quickview | Gives a count of descendants for each person | All | 4 | Doug Blank | DescendantCount.addon.tgz | |
DescendantsLines | Report | Generates a graphical descendants tree using orthogonal edges and routing ("square edges"). | Developer Expert user Intermediate user |
3 | User:Lcc, Adam Sampson | DescendantsLines.addon.tgz | |
Django Exporter/Importer | Exporter/Importer | Import and export your data from gramps-connect.(Requires:Django 1.3 or 1.4) | All | 3 | Doug Blank | Django.addon.tgz | |
DownloadMedia | Tool | N/A | Download media from web pages | All | 1 | Gramps Bugtracker | DownloadMedia.addon.tgz |
ExportRaw | Exporter | A Gramps exporter that will dump your BSDDB database into a flat text version (.raw) of the Python objects. | Developer | 4 | Doug Blank | ExportRaw.addon.tgz | |
Family Sheet | Report | Generates a form with all information about a person, its spouses and its children. (Requires: PIL (Python Imaging Library).) | All | 4 | Reinhard Müller | FamilySheet.addon.tgz | |
Family Tree | Report | Generates a graphical tree of a family with its ancestors and/or descendants. | All | 3 | Reinhard Müller | FamilyTree.addon.tgz | |
FAQ Gramplet | Gramplet | Gramps Frequently Asked Questions | Beginner user | 0 | Gramps Bugtracker | FaqGramplet.py | |
Filtered Reports | Report | Create a descendant report using a filter. | Developer Expert user |
2 | Adam Stein | FilteredReports.addon.tgz | |
Fix Capitalization of Given Names | Tool | Fix Capitalization of Given Names | All | 2 | Donald N. Allingham Doug Blank |
ChangeGivenNames.addon.tgz | |
Google Earth | Mapservice | Show places with GoogleEarth.. | All | 3 | Peter Landgren | GoogleEarthWriteKML.addon.tgz | |
Gramps SQL Database | Exporter/Importer | A Gramps exporter and importer that will export/import your BSDDB database as a fully-relational SQLite database. | Expert users | 3 | Doug Blank | Sqlite.addon.tgz | |
Graph View | View - Experimental | A view that displays a descendant tree based on the active person. Requires PyGoocanvas and Goocanvas. | Testing | N/A | Gary Burton | GraphView.addon.tgz | |
Handle.bash | External utility | A bash script which makes it possible to work with multiple databases merging select branches at will without collisions. | All | 3 | User:Lcc (e-mail) | Handle.bash.tar.gz | |
Headline News Gramplet | Gramplet | Shows Gramps breaking news, once per hour | All | 4 | Gramps Bugtracker | HeadlineNewsGramplet.addon.tgz | |
ImportGramplet | Gramplet | Interface to import Gramps XML text directly | Developers | 2 | Doug Blank | ImportGramplet.addon.tgz | |
InformationGraph | Report | N/A | Generate detailed GraphViz graphs by spidering over the database. | All | N/A | Bob Ham | GVInformationGraph.py |
LastChange | Gramplet and Report | A gramplet and report to display the last ten records changed in the open family tree. The gramplet only displays persons, while the report can display changed famlies, places, and events too. | All | 1 | Jakim Friant | LastChange.addon.tgz | |
libaccess | Library | An experimental gen.lib interface. | Developer | 1 | Doug Blank | libaccess.addon.tgz | |
Lines of Descendency Report | Report | Prints out all descendency lines from a given ancestor to a given descendent in text. | All | 2.5 | User:Lcc (e-mail) | LinesOfDescendency.addon.tgz | |
NoteGramplet | Gramplet | A data entry gramplet for notes. | All | 3 | Doug Blank | NoteGramplet.addon.tgz | |
Number Of Descendants Quickview | Quickview | Shows the number of descendants of the current person | All | 4 | Reinhard Müller | NumberOfDescendantsQuickview.addon.tgz | |
PedigreeChart | Report | A version of the classic pedigree chart that is suitable for printing. (Can optionally use - numpy if installed) | All | 1 | Jakim Friant | PedigreeChart.addon.tgz | |
PersonEverything Report | Report | Show absolutely everything about one person, including all events, notes, citations, sources, attributes, media and the family information about the families they are involved in. | All | 4 | Gramps Bugtracker | PersonEverything.addon.tgz | |
Place completion tool | Tool | A tool to fill in places. | All | 3 | see package. | PlaceCompletion.addon.tgz | |
Plugin Manager Gramplet | Gramplet | Lists plugins available for Gramps | All | 2 | Gramps Bugtracker | PluginManagerGramplet.py | |
Python Gramplet | Gramplet | Interactive Python Shell | Developer | 4 | Gramps Bugtracker | PythonGramplet.addon.tgz | |
QueryGramplet | Gramplet and Report | A SQL-like query system. | All | 1 | Doug Blank | Query.addon.tgz | |
RelatedRelativesGramplet | Gramplet | Display all persons in the database with a relation to a relative. | All | 1 | Heinz Brinker | RelatedRelativesGramplet.addon.tgz | |
RepositoriesReport | Report | Description | All | 3 | Jérôme Rapinat | RepositoriesReport.addon.tgz | |
SetAttributeTool | Tool | A tool for setting attributes and their values on people. | All | 2 | Doug Blank | SetAttributeTool.addon.tgz | |
Thumbnail Generator | Tool | N/A | Generates thumbnails for media files. | All | 3 | Nick Hall | ThumbnailGenerator.addon.tgz |
Timeline Quickview | Quickview | Shows timeline of events in immediate family members' lives | All | 4 | Doug Blank | TimelineQuickview.addon.tgz | |
TimelinePedigreeView | View | Pedigree showing timeline and relationships. | All | 3 | Doug Blank | TimelinePedigreeView.addon.tgz | |
ToDoReport | Report | Tag notes as ToDo (or anything else) and you can generate a report with the notes and the records they are attached to. Another way of maintaining a to-do list within Gramps. | All | 1 | Jakim Friant | ToDoReport.addon.tgz | |
Web Connect Pack | Library | Collection of Web sites for various countries (DE/FR/UK/US) Only install the country you need. (* Requires libwebconnect) | All | 4 | Gramps Bugtracker | libwebconnect.addon.tgz DEWebConnectPack.addon.tgz FRWebConnectPack.addon.tgz UKWebConnectPack.addon.tgz USWebConnectPack.addon.tgz |
Manually installed Addons
A few addons have to be installed manually (or are scripts and need to be installed as described in the documentation).
- Click on a download link from the list of Addons below.
- Open the .ZIP or .gz file and save the contents to your Gramps User Directory, in the
gramps41/plugins
folder - For some addons, you may need to restart Gramps
The Plugin Status window will show you which plugins failed to load, double click on such an entry shows you the error. You can email this error to the plugin contact.
Plugin / Documentation | Type | Image | Description | Use | Rating (out of 4) | Contact | Download |
---|---|---|---|---|---|---|---|
InformationGraph | Report | N/A | Generate detailed GraphViz graphs by spidering over the database. | All | N/A | Bob Ham | GVInformationGraph.py |
Handle.bash | External utility | A bash script which makes it possible to work with multiple databases merging select branches at will without collisions. | All | 3 | User:Lcc (e-mail) | Handle.bash.tar.gz |
See also
Information for Plugin writers
Have you written a plugin for GRAMPS you want to share with the world? Here's how you do it:
- Add the correct license. GRAMPS is GPLv2, you use the GRAMPS plugin system, so make sure you have the correct license at the top of your file. See Howto: Contribute to GRAMPS
- Create a filename.tar.gz or filename.zip file of your plugin code
- Upload the code to this wiki
- Add an entry of your plugin to the list above.
- Create a new wiki page, and refer to that page here, with a short description of what the plugin does
Internationalize it
There is a big possibility that you are not a native English speaker and want your report in your mother tongue. To enable others to use your report, and make it easy to include your report later in GRAMPS without large changes, do the following for text:
Translation function
- Suppose you have a string Name, which you want for your own use in French, so Nom. Then write a translation function with the name _.
- For every string, pass it through your translation function: _("Name")
- Your translation function should then look like this:
mytranslation = { 'Name' : "Nom" } from gettext import gettext import locale lang = locale.getlocale()[0] if lang: lang = lang.split('_')[0] def _(string): if lang == 'fr': return mytranslation.get(string, gettext(string)) else: return gettext(string)
Change here 'fr' by the language code of your language
- If the report becomes part of GRAMPS, it will suffice to delete this code and replace it by
from gettext import gettext as _
- Note that you only need to include strings that are not yet a part of GRAMPS, as those will be translated automatically by the gettext routine
Pitfalls
- We support right to left languages like Arabic, so never constructs text parts by concatenation of pieces. Always use full sentences/paragraphs with variable substitution, so that a right to left language can translate it correctly.
Template
- There is a possible template which lists references.
Translators may add references to their main translation.