gPrime webapp for genealogy
Project description
# gPrime
[![Build Status](https://travis-ci.org/GenealogyCollective/gprime.svg?branch=master)](https://travis-ci.org/GenealogyCollective/gprime) [![codecov](https://codecov.io/gh/GenealogyCollective/gprime/branch/master/graph/badge.svg)](https://codecov.io/gh/GenealogyCollective/gprime)
gPrime 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/
Additional Information
Requirements
Python3
Python package dependencies:
tornado
PIL
simplejson
passlib
meta
Installation
On Windows and Mac, perhaps the easiest method of using gPrime is to start with an [Anaconda Python3 environment](https://www.continuum.io/downloads).
Install from github:
` git clone --depth 1 https://github.com/GenealogyCollective/gprime cd gprime ` Once you have the source files, you can:
` python setup.py build python setup.py install `
or simply:
` pip install . --user -U `
Released version installation:
` pip install gprime `
Getting Started
To run gPrime, you need to do two things:
Create a site directory
Create at least one user and password
To create a site directory, provide a name for the tree, and give the site-dir directory:
` gprime --create="My Family Tree" --site-dir="family_tree" # or, if not installed: python -m gprime.app --create="My Family Tree" --site-dir="family_tree" `
Then, you need at least one user (as an example, we use “demo” as the username):
` gprime --site-dir="~/family_tree" --add-user=demo Password: (does not show any characters) `
Optionally, you may now want to also import some data (see below). The site-directory has a folder named “media” for all of the images and other documents. You can copy them here, or, in the previous example, make ~/family_tree/media link to your media folder.
Running
You can run gprime directly from either the downloaded directory, or from the installed version.
Installed version:
` gprime --config-file="familytree.conf" `
Downloaded versions:
` export PYTHONPATH=/path/to/gprime python -m gprime.app --config-file="familytree.cfg" `
Where familytree.cfg contains options and values, such as:
` port = 8001 site_dir = "My_Family_Tree_Folder" ` or
` site_dir = "/home/dblank/Desktop/Blank_Family/Blank Family/" `
Put this in your site folder named “config.cfg” to use automatically.
Options:
–site-dir=PATH/TO/FOLDER - The directory of the gPrime site directory (required)
–sitename=”Site Name” - Name to use for the site (optional, “gPrime” is default)
–create=TREE-NAME - Create a site directory (given by –site-dir) and family tree database with TREE-NAME
–add-user=USERNAME - Add a username and password; prompts for password if –password not given
–remove-user=USERNAME - Remove a user’s username and password from “SITE-DIR/passwd” file
–change-password=USERNAME - Change a user’s password; prompts for password if –password not given
–password=PASSWORD - Use with –change-password, or –add-user (this option is not recommended)
–import-file=FILENAME - Import a Gramps-supported file type (.ged, .gramps, .json, etc.)
–config-file=FILE - A config file of these options (optional); alternatively, will use SITE-DIR/config.cfg if one
–port=PORT-NUMBER - Port to listen on (8000 is default)
–hostname=LOCALHOST - Hostname to listen on (“localhost” is default)
–server=True|False - Start the server? Default is True
–open-browser=True|False - open a web browser on startup?
–debug=True|False - Use to see additional debugging information; useful for development (auto-restarts server)
–xsrf=True/False - Use cross-site request forgery protection (recommended)
–help - List additional options and details
Common variations
` gprime --help gprime --site-dir="family_tree_folder" --create="Smith Family" gprime --site-dir="family_tree_folder" --import-file="myinfo.gramps" gprime --site-dir="family_tree_folder" --add-user=demo --password=demo gprime --site-dir="/path/to/family_tree_folder" `
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gprime-1.0.8a0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9cbd56b6c5cb46a4af19f23dbfd2f21807e0825ebf34f3681965fe558e490fd |
|
MD5 | 5ced092983985c38324760f674865bc0 |
|
BLAKE2b-256 | e73d7888faf54b6dd1440d5740cc20f4f0770cd551703ee83742016b63ffca62 |