Open main menu

Gramps β

5.2 Addons

Gramps-notes.png
This page list Third-party Addons written by users and developers to work only with Gramps version 5.2.

Please use carefully on data that is backed up.
Help make these Third-party Addons better by reporting any comments or problems to the author, or issues and Feature requests to the bug tracker
Unless otherwise stated on this page, you can download these plugin by following these instructions. An Addons Offline Manual is available for review.
Please note that some Addons have prerequisites that need to be installed before they can be used.
These Third-party Addons unless stated are not officially part of Gramps.
This Addon/Plugin system is controlled by the Addon Manager and Plugin Manager.

Gramps comes with a core set of plugins which provide all of the critical features.

However, you can extend this functionality with additional Third-party Addons. These addons provide reports, filters, View modes, Gramplets, and more.

From Gramps Addon Manager...> Scheduled update checks section, you can check for available extra (or updated) addons and select which to download. Then, they will be retrieved from the internet from the Gramps-Project file server and installed locally on your computer.

Once installed, an addon is found in the same place as a built-in feature of the same Type. That is, Tool addons become new menu items on the Tools menu... while addon Gramplets become new choices in the appropriate Category View sidebar, bottombar or Dashboard options.

Installed addons can be enabled or disabled via the Plugin Manager.

Tango-Dialog-information.png
Can not find it?

The Plugin Manager and Preferences are good places to search when a feature is being elusive.

Addons are not typically cross-referenced in the wiki and might not be where you would expect in the interface.

What you recalled as a Report might actually be a Quick View... and those are found in entirely different menus. Or you might have installed an Addon for a different machine or in another version of Gramps.

So looking through the addons available for download and among those installed can help you rediscover the feature.


Contents

Installing Addons in Gramps

 
Fig. .1 "Addon Manager..." window showing default "Settings..." for Gramps 5.2

You can have Gramps manage the process of checking and downloading Addon updates by changing your settings to match the highlighted section in the screenshot to the right or read the following.

To configure Gramps for Addons:

  1. Start Gramps
  2. Select Menu Edit -> Addon Manager...
  3. Go to the Settings tab
  4. In the Scheduled update checks section:
  5. Change Check for addon updates: so when you start Gramps, it checks for updated Addons:
    1. Once a week - checks for updates when you start Gramps once a week (This is the recommended setting but you can choose any of the other time periods.)
  6. Change What to check so when you check for updates, it checks for:
    1. New and updated addons - checks for all new and updated addons (This is the recommended setting)
  7. Change the Do not ask about previously notified addons checkbox to:
    1. Unchecked as it means that new/updated addons are always shown to you (This is the recommended setting)
  8. If needed you can verify that in the Project's tab > Where to check option has the correct URL. To locate the list of addons for your current language and version, it should be set to:
    https://raw.githubusercontent.com/gramps-project/addons/master/gramps52 if not; select the Restore project defaults button. (Also see the Discourse forum discussion for the URL of the 5.2 beta repository of Isotammi addons.)
  9. Assuming you have an Internet connection. You can now optionally select the Check for updated addons now button to force a check for Addons using the updated settings.
  10. From the Available Gramps Updates for Addons window you will be shown a list broken down by Type that you can view by selecting the "Select" column expand out each "Type".
  11. You can then select the check box of those Addons you want to install.
  12. Then select the Install Selected Addons button to download those Addons from the Internet.
  13. Once downloaded from the Done downloading and installing addons dialog select the Close button
  14. From the Preferences dialog select Close button.
  15. To use the Addons you need to Family Trees>Quit and restart Gramps.
 
"Available Gramps Updates for Addons" window showing example listing output for Gramps 5.2


Addon List

Addons are listed inside of Gramps through the interface described above. The Plug-in Manager list includes the built-in Gramplets as well as any downloaded third party addons... such as those in the following list.

 

for details of on each columns.


Plugin / Documentation Type Image Description Use Rating (out of 4) Contact Download
All Names of All People Quickview Shows all names for all people All 4 Gramps Bugtracker
Doug Blank
AllNamesQuickview.addon.tgz
Ancestors map View A Geography category View Mode which maps Event Places related to the Ancestors of the Home Person. All 1 Gramps Bugtracker
Serge Noiraud
GeoAncestor.addon.tgz
Attach Source Tool A tool to attach a source to a group of people. All 1 Gramps Bugtracker
Doug Blank
AttachSourceTool.addon.tgz
Avatar Generator Tool Tool A tool that allows you to add and remove one or several images for a selected set of filtered people. All 4 Matthias Kemmer AvatarGenerator.addon.tgz
DNA Segment Map Gramplet Gramplet showing a matching DNA segment map (attribute) All 4 Gramps Bugtracker
Nick Hall, Gary Griffin
DNA.addon.tgz
DNA Matches Gramplet Gramplet presents the users with a table of people whose DNA has a match with the currently selected person. All 4 Gramps Bugtracker
(Milan a.k.a RampantSpirit)
DNAMatches.addon.tgz
Event Description Editor Tool A tool that allows you to find and replace a text string in the event description of multiple events. All 4 Matthias Kemmer EventDescriptionEditor.addon.tgz
Biography Quickview Shows a text biography based on the events of the selected Person All 4 A. Guinane BiographyQuickview.addon.tgz
Number of ancestors Quickview A quickview similar to the Number of Ancestors text report. All 4 Matthias Kemmer NumberOfAncestorsQuickview.addon.tgz
Family Relationship Tool Tool N/A A tool that allows editing family relationships of multiple families. All 4 Matthias Kemmer FamilyRelationshipTool.addon.tgz
Heatmap Report Create a heatmap web report. All 4 Matthias Kemmer Heatmap.addon.tgz
Media Report Report A text report for images, which allows custom headings and custom notes as well as image data like notes, citations, tags, attributes and people references. All 4 Matthias Kemmer MediaReport.addon.tgz
Double Cousin Report N/A Double Cousin is a text report which lists special multiplicities of cousins like double cousins. All 4 Matthias Kemmer DoubleCousins.addon.tgz
Set Privacy Tool Tool The Set Privacy Tool allows you to manage privacy status of people, events and media All 4 Matthias Kemmer SetPrivacyTool.addon.tgz
Birthdays Gramplet   Display the upcoming birthdays All 1 Peter Potrowl BirthdaysGramplet.addon.tgz
Sort Children in Birth order Tool   Sort children in families in their birth order All 3 Paul Culley BirthOrder.addon.tgz
Media Browser Gramplet   Display shows details of a person linked media objects. All 4 Gramps Bugtracker MediaBrowser.addon.tgz
Clock Gramplet A sample Cairo clock gramplet. Developer 1 Gramps Bugtracker
Doug Blank
ClockGramplet.addon.tgz
Calculate Estimated Dates Tool A tool to set estimated birth and death dates. All 2 Gramps Bugtracker
Doug Blank
CalculateEstimatedDates.addon.tgz
Check Associations data Tool ‎Associations state tool dialog Will check the data on Association for people.
menu Tools -> Utilities -> Check Associations data...
All Gramps Bugtracker
Jerome Rapinat
AssociationsTool.addon.tgz
Combined View A Relationships category View Mode showing relationships and events for a person. Like the built-in Relationships View but on steroids. All 1 Gramps Bugtracker
Nick Hall
CombinedView.addon.tgz
Collections Clipboard Gramplet Allows one to group items together for quick access. All 2 Gramps Bugtracker
Doug Blank
ClipboardGramplet.addon.tgz
Command Line Merge Tool N/A Merge primary object via the command line. (Note: Used by Gramps project to test its code you can see an example of how it used programmatically here) Developer 3 Gramps Bugtracker
Michiel D. Nauta
CliMerge.addon.tgz
D3 Ancestral and Descendant Charts Web Report   Create ancestral/descendant web based interactive D3 charts. All 3 Matt Keenan D3Charts.addon.tgz
Database Differences Report Report   Allows a mostly complete comparison between the current database and a Gramps XML file All 2 Gramps Bugtracker Differences.addon.tgz
Data Entry Gramplet Gramplet Quick Data Entry for People data Expert user 4 Gramps Bugtracker DataEntryGramplet.addon.tgz
Date Calculator Gramplet Allows you to do date math. Normal user 3 Gramps Bugtracker DateCalculator.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 Gramps Bugtracker
Michiel Nauta
DenominoViso.addon.tgz
Descendant Book
and
Detailed Descendant Book
Report   Create a book of descendant or detailed descendant reports using a filter. All 4 Matt Keenan
Giansalvo Gusinu
DescendantBooks.addon.tgz
Detailed Descendant Report With All Images Report Produces a detailed descendant report with all images and optional todo list. All 4 Jon Schewe DetDescendantReport-images.addon.tgz
Descendant Count Gramplet and Quickview Gives a count of descendants for each person All 4 Gramps Bugtracker
Doug Blank
DescendantCount.addon.tgz
Descendants Lines Report   Generates a graphical descendants tree using orthogonal edges and routing ("square edges"). All 3 Gramps Bugtracker
User:Lcc
Adam Sampson
Giansalvo Gusinu
DescendantsLines.addon.tgz
Download media files from the internet Tool Download media from web pages All 1 Gramps Bugtracker DownloadMedia.addon.tgz
Dynamic Web Report Report   Exports the Family Tree as Web pages that are generated dynamically by client-side Javascript(no server required). All 3 Gramps Bugtracker
Pierre Bélissent
DynamicWeb.addon.tgz
Export Raw Exporter A Gramps exporter that will dump your BSDDB database into a flat text version (.raw) of the Python objects. Developer 4 Gramps Bugtracker
Doug Blank
ExportRaw.addon.tgz
Extract Place Data from a Place Title Tool Attempts to extract city and state/province from a place title All 3 Gramps Bugtracker ExtractCity.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 Gramps Bugtracker
Reinhard Müller
FamilySheet.addon.tgz
Family Tree Report Generates a graphical tree of a family with its ancestors and/or descendants. All 3 Gramps Bugtracker
Reinhard Müller
FamilyTree.addon.tgz
Fix Capitalization of Given Names Tool Fix Capitalization of Given Names All 2 Gramps Bugtracker
Donald N. Allingham
Doug Blank
ChangeGivenNames.addon.tgz
Forms Gramplet Gramplet   Forms gramplet that allows users to create and edit structured source data in a single form, such as birth, marriage and death certificates and parish register entries. All 1 Nick Hall Form.addon.tgz
Export GEDCOM Extensions (GED2) Exporter Collection of unofficial GEDCOM extensions which extend Gramps GedcomWriter to include common non-compliant GEDCOM additions.. Expert user 2 Gramps Bugtracker
Doug Blank
GedcomExtensions.addon.tgz
Tree Reports:
  • Ancestor Tree
  • Descendant Tree
  • Grandparent Tree
  • Sandclock Tree
  • Sandclock Tree for a Family
Report   A group of 5 Tree reports that use LaTeX genealogytree (the Pedigree and genealogical tree diagrams package) to create professional looking trees for the active person. Four report are available. Requires: texlive/texlive-pictures and texlive-fontsextra Developer
Expert user
Intermediate user
3 Gramps Bugtracker
Nick Hall
GenealogyTree.addon.tgz
Geneanet import for Gramps Tool A tool that allows you to import Geneanet ascendants and descendants of a selected person into Gramps. Requires both the Request and lxml prerequisites to work. All 3 Bruno Cornec GeneanetForGramps.addon.tgz
GetGOV Gramplet Download places from the GOV genealogical gazetteer. Expert user 2 Gary Griffin GetGOV.addon.tgz
GoogleEarth Mapservice Show places with GoogleEarth.. All 3 Peter Landgren GoogleEarthWriteKML.addon.tgz
SQLite Export
SQLite Import
Exporter/Importer A Gramps exporter and importer that will export/import your Family Tree as a fully-relational SQLite database. Expert users 3 Gramps Bugtracker
Doug Blank
Sqlite.addon.tgz
JSON Export
JSON Import
Exporter/Importer A Gramps exporter and importer that will export/import your Family Tree as a JSON file. Expert users 3 Gramps Bugtracker
Doug Blank
JSON.addon.tgz
Graph View View A Graph category View Mode that can display the active persons ancestor tree and descendant tree. Requires PyGoocanvas and Goocanvas. All 3 Gramps Bugtracker
Gary Burton
GraphView.addon.tgz
Edit Image Exif Metadata Gramplet Gramplet to view, edit, and save image Exif metadata. All 3 Rob G. Healey, Paul Culley editexifmetadata.py
Headline News Gramplet Shows Gramps breaking news, once a day. All 4 Gramps Bugtracker HeadlineNewsGramplet.addon.tgz
House Timeline Gramplet Lists the Residents of an Address by Timeline All 4 Gramps Bugtracker HouseTimelineGramplet.addon.tgz
H-Tree Pedigree View A Graph category View Mode with an H-tree based layout that can be used to display ancestral trees. All 3 Gramps Bugtracker HtreePedigreeView.addon.tgz
Import Text Gramplet Interface to import text directly in the following formats: CSV (spreadsheet input and multiple delimiter dialects), Gramps XML, vCard 3.0. Developers 2 Gramps Bugtracker
Doug Blank
ImportGramplet.addon.tgz
Import and Merge tool Tool Compares a Gramps XML database with the current one, and allows merging of the differences. All 4 Paul Culley ImportMerge.addon.tgz
Information Graph Report N/A Generate detailed GraphViz graphs by spidering over the database. All 0 Bob Ham GVInformationGraph.py
Interactive Family Tree Tool Opens an interactive tree in the browser. This tool uses the Topola Genealogy Viewer to display the family tree. All 4 GitHub issue tracker Topola.addon.tgz
Last Change 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 families, places, and events too. All 1 Jakim Friant LastChange.addon.tgz
Generic DB Access lib Library The Generic DB Access lib (AKA libaccess) is an experimental library that provides generic access to the database and the gen.lib interface. Developer 1 Gramps Bugtracker
Doug Blank
libaccess.addon.tgz
Life Line Ancestor Chart
Life Line Descendant Chart
View A Graph category View Mode which shows individuals as lines in an ancestor or descendant chart along a time span. All 3 Gramps Bugtracker
CWSchulze
Lines of Descendency Report Report Prints out all descendency lines from a given ancestor to a given descendant in text. All 2.5 User:Lcc (e-mail) LinesOfDescendency.addon.tgz
Merge Media Tool Searches for Media entries that point to the same media file and merges them together. All 4 Paul Culley MediaMerge.addon.tgz
Media Verify Tool Verify a one-to-one relationship between media objects and files in the media directory. The main purpose of the tool is to locate files that have been moved and fix the paths. All 4 Gramps Bugtracker MediaVerify.addon.tgz
MongoDB Database N/A MongoDB database backend support. For Experts only! This is an Experimental Unreleased addon. Developer 2 Gramps Bugtracker MongoDB.addon.tgz
Network Chart Website Generate a single graph showing connectivity between individuals Expert user 3 Mark B. NetworkChart.addon.tgz
Note Gramplet Gramplet A data entry gramplet for notes. All 3 Gramps Bugtracker
Doug Blank
NoteGramplet.addon.tgz
Note Cleanup Tool A tool to clean up html and convert to Styled Text in notes. Also converts Web links to Styled text. All 3 Paul Culley NoteCleanup.addon.tgz
Number of descendants Quickview Shows the number of descendants of the current active person All 4 Gramps Bugtracker
Reinhard Müller
NumberOfDescendantsQuickview.addon.tgz
Participants Gramplet   Display the participants in an event. All 4 Gramps Bugtracker Participants.addon.tgz
Pedigree Chart 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
Photo Tagging Gramplet Enables tagging people in photographs, i.e. associating regions of images with Gramps persons. (Requires: OpenCV(for automatic face detection)& Numpy ) All 4 Gramps Bugtracker PhotoTaggingGramplet.addon.tgz
Place and Coordinates Gramplet Gramplet simplifies setting the coordinates of a place; packaged with an All 3 Christian Schulze PlaceCoordinateGeoView.py
Place Coordinate Gramplet view View
additional Geography category View Mode packaged with the Place and Coordinates Gramplet simplifies setting coordinates interactively. All 3 Christian Schulze PlaceCoordinateGeoView.py


Place Cleanup Gramplet Place Cleanup Gramplet assists in merging places, as well as completing places from the GeoNames web database. All 3 Paul Culley PlaceCleanup.addon.tgz
PlaceCompletion Tool A tool to fill in places. All 3 Gramps Bugtracker PlaceCompletion.addon.tgz
PlaceUpdate Gramplet Gramplet to manipulate multiple places. All 3 Kari Kujansuu
Gramps Bugtracker
PlaceUpdate.addon.tgz
PostgreSQL Database N/A PostgreSQL database backend support. Expert User 2 Gramps Bugtracker PostgreSQL.addon.tgz
Prerequisites Checker Gramplet   Diagnostic tool to help work out if users have the required prerequisites installed as well as the latest version of Gramps. Expert user 1 Gramps Bugtracker PrerequisitesCheckerGramplet.addon.tgz
Python Shell Gramplet Interactive Python Shell Developer 4 Gramps Bugtracker PythonGramplet.addon.tgz
Plugin Manager Enhanced Plugin lib and Gramplet A Plugin manager with additional capabilities All 4 Paul Culley PluginManager.addon.tgz
Sources and Citations Report Report A text report for source and citations with notes. All 4 Gramps Bugtracker SourcesCitationsReport.addon.tgz
Sync Associations Tool N/A Add reciprocal Associations if missing. All 2 Gary Griffin SyncAssociations.addon.tgz
Tiny Tafel
(Liste éclair)
Report Provides a compact way of describing the main surnames found in a family genealogy, which can be read by humans and matched by computers using a Tafel Matching System. All 4 Gramps Bugtracker
Eric doutreleau
ListeEclair.addon.tgz
Query Gramplet Gramplet and Report A SQL-like query system. All 1 Gramps Bugtracker
Doug Blank
Query.addon.tgz
Quilt Chart View A Graph category View Mode that presents your family tree in the form of a grid. Expert users 3 Gramps Bugtracker
Serge Noiraud, Nick Hall
QuiltView.addon.tgz
Related Relatives Gramplet   Display all persons in the database with a relation to a relative. All 1 Heinz Brinker RelatedRelativesGramplet.addon.tgz
Add/Remove Tag Tool Tool The Add/Remove Tag Tool allows you to add or remove one tag from a selected set of filtered objects e.g. people. All 4 Matthias Kemmer RemoveTagTool.addon.tgz
Repositories Report Report A set of Text reports to list repositories and their related sources information, useful when going to a repository (like an archive). All 3 Gramps Bugtracker
Jérôme Rapinat
RepositoriesReport.addon.tgz
Set Attribute Tool A tool for setting attributes and their values on people. All 2 Gramps Bugtracker
Doug Blank
SetAttributeTool.addon.tgz
Theme preferences Settings An addition to Preferences for simple Theme and Font adjustment. Especially useful for Windows users. All 3 Paul Culley Themes.addon.tgz
This Day in Family History Gramplet   Display the upcoming a concise report of the user defined list of events that happened on this day and month. All 1 Stephen Adams ThisDayInFamilyHistory.addon.tgz
Thumbnail Generator Tool   Generates thumbnails for media files. All 3 Nick Hall ThumbnailGenerator.addon.tgz
Type Cleanup Tool A tool to Remove unneeded custom Types. All 4 Paul Culley TypeCleanup.addon.tgz
Timeline Quickview Shows timeline of events in immediate family members' lives All 4 Gramps Bugtracker
Doug Blank
TimelineQuickview.addon.tgz
Timeline Pedigree View A Graph category View Mode showing Pedigree timeline and relationships. All 3 Gramps Bugtracker
Doug Blank
TimelinePedigreeView.addon.tgz
Todo Report 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
DE Web Connect Pack
FR Web Connect Pack
NL Web Connect Pack
RU Web Connect Pack
SV Web Connect Pack
UK Web Connect Pack
US Web Connect Pack
Library Collection of Web sites for various countries (DE/FR/SV/UK/US) Only install the country you need. (* Requires libwebconnect) All 4 Gramps Bugtracker libwebconnect.addon.tgz
DEWebConnectPack.addon.tgz
FRWebConnectPack.addon.tgz
SVWebConnectPack.addon.tgz
UKWebConnectPack.addon.tgz
USWebConnectPack.addon.tgz
Gramps Web Sync Tool Gramps Web Sync is an addon for Gramps that allows to synchronize your Gramps database on your desktop computer with Gramps Web, including media files. Intermediate user 3 DavidMStraub/ gramps-web-sync issues GrampsWebSync.addon.tgz
Restart where you were last working Library This addon causes Gramps to restart on the same view and object where Gramps was previously closed. All 4 Paul Culley RestoreHist.addon.tgz
Extended Family Attributes Gramplet
Extended Person Attributes Gramplet
Gramplet Gramplet showing the attributes of a family or person. All 4 Gramps Bugtracker
Nick Hall
ExtendedAttributes.addon.tgz

Manually installed Addons

A few addons have to be installed manually. Some are scripts and need to be installed as described in the documentation provided with that addon. Some are still in the exploratory stage and have not yet been published to the list used by the Addon Manager.

Addons in the exploratory stages tend to be initially posted to the GitHub Gramps-Project repositories and have to be manually installed. Be certain to backup your Tree before installing anything. There is a potential for data loss with such preliminary versions.

  1. Download the compressed file. (Click on a download link from the list of Addons below; or for unpublished exploratory addons, select the Download ZIP option from the <> Code button's menu in their GitHub repository)
  2. Open the compressed file ( *.ZIP ; *.gz ; *.tgz / etc ...using 7-ZIP) and extract the contents to in your Gramps User Directory, in the gramps52/plugins folder.
  3. After manually installing any addons, it may be necessary to restart Gramps to register plug-ins again.

The ZipInstall addon from the Isotammi project of the Finland Genealogical Society can simplify the install of a downloaded ZIP (or a .tgz) compressed archive from GitHub.

 
Addon/Plugin Errors

Any addons/plugins which failed to load can be identified in the Help > Plugin Manager. View the Status column and double-click on any entry that shows an error. Some may rely on prerequisite modules that need to be installed.
You can report any errors 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. The InformationGraph plugin only works with Gramps 3.2
For a similar report see the: Addon:PersonEverything Report
All 1 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
Isotammi addons Isotammi project addons

Gramplets:

  • Isotammi configuration
  • Dates
  • Position tool

Rules:

  • Events with an invalid date
  • Events with a valid date

Tool:

  • Generate source references based on more information
All ? http://wiki.isotammi.net/wiki/Gramps-laajennukset https://github.com/Taapeli/isotammi-addons

Addons for other versions of Gramps

Addons for other versions of Gramps can be found on the following pages

See also

Writing an Addon/Plugin