4.2 Addons

From Gramps
Revision as of 09:27, 9 September 2024 by Gioto (talk | contribs) (Addon List)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Gramps-notes.png
This page list Third-party Addons written by users and developers to work only with Gramps version 4.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
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 Plugin Manager.


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

However, you can extend this functionality with additional Third-party Addons. These addons provide reports, listings, views, gramplets, and more.

From Gramps you can select among the available extra addons, they will be retrieved from the internet from the Gramps website, and installed locally on your computer.

Installing Addons in Gramps

General Preferences

You can have Gramps manage the process of checking and downloading Addon updates.

To configure Gramps for Addons:

  1. Start Gramps
  2. Select Menu Edit -> Preferences...
  3. Go to the General tab
  4. Change Check for updates so when you start Gramps, it checks for updated Addons:
    1. Never - never checks for updates when you start Gramps (This is the default setting}
    2. Once a month - checks for updates when you start Gramps once a month
    3. Once a week - checks for updates when you start Gramps once a week (This is the recommended setting)
    4. Once a day - checks for updates when you start Gramps once a day
    5. Always - checks for updates whenever you start Gramps
  5. Change What to check so when you check for updates, it checks for:
    1. Updated addons only - does not check for new addons
    2. New addons only - does not check for updated addons (This is the default setting}
    3. New and updated addons - checks for all new and updated addons (This is the recommended setting)
  6. Change the Do not ask about previously notified addons check box:
    1. Check it so that new/updated addons are only asked about once; afterwards it doesn't show them to you (This is the recommended setting)
    2. Uncheck it so that new/updated addons are always shown to you (This is the default setting}
  7. Assuming you have an Internet connection. You can now optionally select the Check now button to force a check for Addons using the updated settings.
  8. 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".
  9. You can then select the check box of those Addons you want to install.
  10. Then select the Install Selected Addons button to download those Addons from the Internet.
  11. Once downloaded from the Done downloading and installing addons dialog select the Close button
  12. From the Preferences dialog select Close button.
  13. 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 4.2


Addon List

Addons are listed inside of Gramps through the interface described above.

Tango-Dialog-information.png

for details of on each columns.

Plugin / Documentation Type Image Description Use Rating (out of 4) Contact Download
All Names Quickview Quickview
All-names-quickview-41.png
Shows all names for all people All 4 Doug Blank AllNamesQuickview.addon.tgz
AttachSourceTool Tool
AttachSourceTool-Options-dialog-41.png
A tool to attach a source to a group of people. All 1 Doug Blank AttachSourceTool.addon.tgz
BirthdaysGramplet Gramplet BirthdaysGramplet-detached-view-41.png Display the upcoming birthdays All 1 Peter Potrowl BirthdayGramplet.addon.tgz
BirthOrderTool Tool BirthOrder.png Sort children in families in their birth order All 3 Paul Culley BirthOrder.addon.tgz
Cairo Clock Gramplet Gramplet
ClockGramplet-detatched-41.png
A sample Cairo clock gramplet. Developer 1 Doug Blank ClockGramplet.addon.tgz
Calculate Estimated Dates Tool
Calculate-estimated-dates-select-tab-41.png
A tool to set estimated birth and death dates. All 2 Doug Blank CalculateEstimatedDates.addon.tgz
ClipboardGramplet Gramplet
ClipboardGramplet.png
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 D3Chart-AncestralCollapsibleTree.png Create ancestral/descendant web based interactive D3 charts. All 3 Matt Keenan D3Charts.addon.tgz
Data Entry Gramplet Gramplet
Data-entry-gramplet-default-dialog-42.png
Quick Data Entry for People data Expert user 4 Gramps Bugtracker DataEntryGramplet.addon.tgz
Date Calculator Gramplet Gramplet
Date-calculator-gramplet-example-result-gramps42.png
Allows you to do date math. Normal user 3 Gramps Bugtracker DateCalculator.addon.tgz
Deep Connections Gramplet Gramplet
Deep-Connections-Gramplet-example-view-41.png
Finds deep relationships between home and active people All 3 Gramps Bugtracker DeepConnectionsGramplet.addon.tgz
DenominoViso Web report
DenominoVisoWebReport.png
Creates interactive graphical ancestor/descendant tree on a webpage. All 3 Michiel Nauta DenominoViso.addon.tgz
Descendant and Detailed Descendant Book Reports Report DescendantBook.png Create a book of descendant or detailed descendant reports using a filter. All 2 Matt Keenan 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 Gramplet and Quickview
DescendantCountGramplet-41.png
Gives a count of descendants for each person All 4 Doug Blank DescendantCount.addon.tgz
DescendantsLines Report JohnShakespeare-DescendantsLines.png 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
DjangoImportExport.jpg
Import and export your data from gramps-connect.(Requires:Django 1.7 or 1.8) All 3 Doug Blank Django.addon.tgz
DownloadMedia Tool N/A Download media from web pages All 1 Gramps Bugtracker DownloadMedia.addon.tgz
DynamicWeb report Report DynamicWeb-tree1.png Exports the database as Web pages. The Web pages are generated dynamically by client-side Javascript (no server required). All ? Pierre Bélissent DynamicWeb.addon.tgz
ExportRaw Exporter
ExportRaw.jpg
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
Sample Family Sheet
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
FamilyTree.gif
Generates a graphical tree of a family with its ancestors and/or descendants. All 3 Reinhard Müller FamilyTree.addon.tgz
FAQ Gramplet Gramplet
FAQ.jpg
Gramps Frequently Asked Questions Beginner user 0 Gramps Bugtracker FaqGramplet.py
Filtered Reports Report
FilteredDescendantReport.png
Create a descendant report using a filter. Developer
Expert user
2 Adam Stein FilteredReports.addon.tgz
Fix Capitalization of Given Names Tool
FixCapitalization-of-Given-Names-addon-example-41.png
Fix Capitalization of Given Names All 2 Donald N. Allingham
Doug Blank
ChangeGivenNames.addon.tgz
GetGOV Gramplet
GetGOV.png
Download places from the GOV genealogical gazetteer. Expert user 2 Gary Griffin GetGOV.addon.tgz
Google Earth Mapservice
GoogleEarth-mapservices-selection-dropdown-41.png
Show places with GoogleEarth.. All 3 Peter Landgren GoogleEarthWriteKML.addon.tgz
Gramps SQL Database Exporter/Importer
ExportSQL.jpg
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
Graph-View-plugin-addon-example-42.png
A view that displays a descendant tree based on the active person. Requires PyGoocanvas and Goocanvas. Testing 3 Gary Burton GraphView.addon.tgz
Handle.bash External utility
Bashhandle.gif
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
HeadlineNewsGramplet-41.png
Shows Gramps breaking news, once per hour All 4 Gramps Bugtracker HeadlineNewsGramplet.addon.tgz
House Timeline Gramplet Gramplet
HouseTimeline-detached-gramplet.PNG
Lists the Residents of an Address by Timeline All 4 Gramps Bugtracker HouseTimelineGramplet.addon.tgz
HtmlView HtmlView
Html View
A view showing html pages embedded in Gramps All 3 Gramps Bugtracker HtmlView.addon.tgz
ImportGramplet Gramplet
ImportGramplet.png
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 0 Bob Ham GVInformationGraph.py
LastChange Gramplet and Report
Last change report sample.png
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
libaccess Library
Libaccess.jpg
An experimental gen.lib interface. Developer 1 Doug Blank libaccess.addon.tgz
Lines of Descendency Report Report
Lines-of-descendency.jpeg
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
NetworkChart Website
Shakespeare network 1 dynamic url.svg
Generate a single graph showing connectivity between individuals Expert user 3 Mark B. NetworkChart.addon.tgz
NoteGramplet Gramplet
NoteGramplet.png
A data entry gramplet for notes. All 3 Doug Blank NoteGramplet.addon.tgz
NoteCleanupTool Tool
Note Cleanup Tool.png
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 Quickview
Number-of-descendants-quickview-41.png
Shows the number of descendants of the current person All 4 Reinhard Müller NumberOfDescendantsQuickview.addon.tgz
PedigreeChart Report
PedigreeChart-example-pdf-output-41.png
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
PersonEverything sample output.jpg
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
Place completion tool empty.jpg
A tool to fill in places. All 3 see package. PlaceCompletion.addon.tgz
Python Gramplet Gramplet
Python-gramplet-interactive-shell-example-41.png
Interactive Python Shell Developer 4 Gramps Bugtracker PythonGramplet.addon.tgz
QueryGramplet Gramplet and Report
QueryGramplet.jpg
A SQL-like query system. All 1 Doug Blank Query.addon.tgz
RelatedRelativesGramplet Gramplet RelatedRelativesGramplet-41.png Display all persons in the database with a relation to a relative. All 1 Heinz Brinker RelatedRelativesGramplet.addon.tgz
RepositoriesReport Report
RepositoriesReport.png
All 3 Jérôme Rapinat RepositoriesReport.addon.tgz
SetAttributeTool Tool
SetAttributeTool-gramps50.png
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
Timeline-quickview-41.png
Shows timeline of events in immediate family members' lives All 4 Doug Blank TimelineQuickview.addon.tgz
TimelinePedigreeView View
TimelinePedigreeView-41.png
Pedigree showing timeline and relationships. All 3 Doug Blank TimelinePedigreeView.addon.tgz
ToDoReport Report
Todo report sample output.png
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
Web-connect-pack-UK-menu-41.png
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).

  1. Click on a download link from the list of Addons below.
  2. Open the .ZIP or .gz file and save the contents to your Gramps User Directory, in the gramps42/plugins folder
  3. For all addons, you need to restart Gramps
Gramps-notes.png
Addon/Plugin Errors

From the Help > Plugin Manager you can see which addons/plugins failed to load by viewing the Status column, and then double clicking 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 1 Bob Ham GVInformationGraph.py
Handle.bash External utility
Bashhandle.gif
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

Plugins for previous versions of Gramps

Plugins for previous versions of Gramps can be found on the following pages

Writing a Plugin

See also