gPrime webapp for genealogy
Project description
# 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/
Requirements
------------
* Python3
* tornado
* PIL
* simplejson
Installation
-------------
Install from github:
```shell
git clone --depth 1 https://github.com/GenealogyCollective/gprime
cd gprime
python3 setup.py build
sudo python3 setup.py install
```
Released version installation (once released):
```shell
pip3 install gprime
```
Running
-------
You can run gprime directly from either the downloaded directory, or from the installed version.
Installed version:
```shell
python3 -m gprime.app --config="familytree.conf"
```
Downloaded versions:
```shell
export PYTHONPATH=/path/to/gprime
python3 -m gprime.app --config="familytree.conf"
```
Where `familytree.conf` contains options and values, such as:
```python
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:
------------
* --create - Create a directory and family tree
* --import-file - Import a Gramps-supported file type (.ged, .gramps, .json, etc.)
* --database - The directory or name of the database
* --username - Username (demo)
* --password - Password (demo)
* --debug - Use to see additional debugging information
* --port - Port to use (8000 is default)
* --hostname - Hostname to use (localhost is default)
* --sitename - Name to use for the site (gPrime is default)
* --data_dir - Folder of gprime/data
* --home_dir - Gramps home
* --server - Start the server? Default is True
* --xsrf - Use cross-site request forgery protection
Common variations
-----------------
```shell
python3 -m gprime.app --create="Smith Family" --username=demo --server=False
python3 -m gprime.app --database="Smith Family" --import-file="myinfo.gramps" --username=demo --server=False
python3 -m gprime.app --database="Smith Family" --username=demo
python3 -m gprime.app --help
```
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/
Requirements
------------
* Python3
* tornado
* PIL
* simplejson
Installation
-------------
Install from github:
```shell
git clone --depth 1 https://github.com/GenealogyCollective/gprime
cd gprime
python3 setup.py build
sudo python3 setup.py install
```
Released version installation (once released):
```shell
pip3 install gprime
```
Running
-------
You can run gprime directly from either the downloaded directory, or from the installed version.
Installed version:
```shell
python3 -m gprime.app --config="familytree.conf"
```
Downloaded versions:
```shell
export PYTHONPATH=/path/to/gprime
python3 -m gprime.app --config="familytree.conf"
```
Where `familytree.conf` contains options and values, such as:
```python
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:
------------
* --create - Create a directory and family tree
* --import-file - Import a Gramps-supported file type (.ged, .gramps, .json, etc.)
* --database - The directory or name of the database
* --username - Username (demo)
* --password - Password (demo)
* --debug - Use to see additional debugging information
* --port - Port to use (8000 is default)
* --hostname - Hostname to use (localhost is default)
* --sitename - Name to use for the site (gPrime is default)
* --data_dir - Folder of gprime/data
* --home_dir - Gramps home
* --server - Start the server? Default is True
* --xsrf - Use cross-site request forgery protection
Common variations
-----------------
```shell
python3 -m gprime.app --create="Smith Family" --username=demo --server=False
python3 -m gprime.app --database="Smith Family" --import-file="myinfo.gramps" --username=demo --server=False
python3 -m gprime.app --database="Smith Family" --username=demo
python3 -m gprime.app --help
```
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 Distributions
gprime-0.0.1.zip
(15.2 MB
view hashes)
gprime-0.0.1.tar.gz
(14.0 MB
view hashes)
Built Distribution
Close
Hashes for gprime-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b4b1d7e2ab2e1bd91a72aabfd34fc21531eb7344ff30bf411eb7e25b247069e |
|
MD5 | 23358622065d9110db83e0c26b1c98f6 |
|
BLAKE2b-256 | 5582e273cafc4b98104403219fc84fb47ac18bec415cb48a9e52e71056e33d06 |