Build Status codecov

gPrime is a web-based application for genealogy. It uses the Gramps API for data, reports, import/export, etc.

Additional Information

Get Involved!

gPrime is looking for help on many different topics:

gPrime is also looking for some advsiors! If you would like to help developed focused goals for the future development of gPrime, please let us know:

I'm interested in Advising gPrime


Python package dependencies:


On Windows and Mac, perhaps the easiest method of using gPrime is to start with an Anaconda Python3 environment.

Once you have a Python environment, install gPrime with:

pip install gprime --user -U

(--user installs into user space, not global space. -U updates gPrime and dependencies. Leave off --user and use Adminstrative install method (sudo) to install for everyone.)

Getting Started

To run gPrime, you need to do two things:

  1. Create a site directory
  2. Create at least one user and password

To create a site directory, provide a name for the tree:

gprime --create="My Family Tree"

Then, you need at least one user (as an example, we use "demo" as the username):

gprime --add-user --user=demo
Password: (does not show any characters as you type)

Importing Data

Optionally, you may now want to also import some data (gPrime supports Gramps XML, GEDCOM, and JSON import formats):

gprime --import-file="FamilyTree.gramps"

The site-directory has a folder named "media" for all of the images and other documents. On --file-import, gPrime will atempt to import any identified media by copying them into this media folder. If you want to prevent the copying, use --import-media=False. You can alternatively manually copy files into the media folder, or, in the previous example, make family_tree/media link to your media folder.


You can run gprime directly from either the github-downloaded directory, or from the installed version.

Installed version:



Rather than having to list all of these options on a command-line, you can put them in the SITE-DIR/config.cfg file:

### This is the contents of file SITE-DIR/config.cfg.
### Note that hyphens in option names are converted to underscores.

port     = 8001
site_dir = "My_Family_Tree_Folder"
prefix   = "/jones"
sitename = "Jerry's"

Common variations

gprime --help
gprime --create="Smith Family"
gprime --import-file="myinfo.gramps"
gprime --add-user --user=demo --password=demo
gprime --add-user --user=demo --password=demo --permissions=add,edit
gprime --add-user --user=demo --password=demo --permissions=none