Gramps Connect

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

• Designed for collaboration and large databases
• Multi-user, password protected
• Support IIIF Image Server API - http://iiif.io/api/image/2.1/

Requirements

• Python3
• tornado
• PIL
• gramps >= 5.0
• simplejson

Installation

Pre-release installation:

Before Gramps 5.0 is released, you will need to get Gramps from github:

git clone --depth 1 https://github.com/gramps-project/gramps.git
cd gramps
python3 setup.py build

At that point you can run Gramps directly (using the Gramps.py program in the above folder) and use it for gramps_connect (see below).

You can also get gramps_connect from github:

git clone --depth 1 https://github.com/gramps-project/gramps_connect.git
cd gramps_connect

Released version installation (once Gramps 5.0 is released):

pip3 install gramps
pip3 install gramps_connect

Running

You can run gramps_connect directly from either the downloaded directory, or from the installed version.

Installed version:

python3 -m gramps_connect.app --config="familytree.conf"

Downloaded versions:

cd gramps_connect
PYTHONPATH=../gramps:. python3 -m gramps_connect.app --config="familytree.conf"

Where familytree.conf contains options and values, such as:

port = 8000
database = "My Family Tree"
username = "demo"

If you do not provide --password (a crypt-based password) on the command-line or in the config file then a plaintext password will be interactively requested, and the crypt generated.

Options:

• --database
• --username
• --password
• --debug
• --port
• --hostname
• --sitename
• --data_dir
• --home_dir
• --xsrf

Common variations

PYTHONPATH=/path/to/gramps python3 -m gramps_connect.app --database="Smith Family" --username=demo

python3 -m gramps_connect.app --help

python3 -m gramps_connect.app --debug --base_dir=/path/to/templates --database="Smith Family" --username=demo