gprime 0.0.5

# gPrime

[](https://travis-ci.org/GenealogyCollective/gprime) [](https://codecov.io/gh/GenealogyCollective/gprime)

gPrime是一个基于Web的家谱应用。它使用Gramps API进行数据、报告、导入/导出等。

* 专为协作和大型数据库设计
* 多用户，密码保护
* 支持IIIF图像服务器API - http://iiif.io/api/image/2.1/

附加信息
----------------------

* 博客 - https://genealogycollective.wordpress.com/
* 邮件列表 - https://groups.google.com/forum/#!forum/genealogycollective

要求
------------

* Python3

Python包依赖

* tornado
* PIL
* simplejson
* passlib
* meta

安装
-------------

在Windows和Mac上，使用gPrime的最简单方法可能是从[Anaconda Python3环境](https://www.continuum.io/downloads)开始。

从GitHub安装

```
git clone --depth 1 https://github.com/GenealogyCollective/gprime
cd gprime
```
一旦您有了源文件，您可以

```
python3 setup.py build
python3 setup.py install
```

或简单

```
pip install . --user -U
```

发布版本安装（一旦发布）

```
pip3 install gprime
```

入门指南
---------------

要运行gPrime，您需要做两件事

1. 创建站点目录
2. 创建至少一个用户和密码

要创建站点目录，提供树的名字，并给出站点-dir目录

```
python3 -m gprime.app --create="My Family Tree" --site-dir="family_tree"
```

然后，您至少需要一个用户（例如，我们使用"demo"作为用户名）

```
python3 -m gprime.app --site-dir="~/family_tree" --add-user=demo
密码：（不显示任何字符）
```

可选，您现在可能还想导入一些数据（见下文）。网站目录下有一个名为“media”的文件夹，用于存放所有图片和其他文档。您可以将其复制到这里，或者在之前的示例中，将 ~/family_tree/media 链接到您的媒体文件夹。

运行
-------

您可以从下载的目录或安装的版本直接运行 gprime。

安装版本

```
python3 -m gprime.app --config-file="familytree.conf"
```

下载版本

```
export PYTHONPATH=/path/to/gprime
python3 -m gprime.app --config-file="familytree.cfg"
```

其中 `familytree.cfg` 包含选项和值，例如

```
端口 = 8001
site_dir = "My_Family_Tree_Folder"
```
或者

```
site_dir = "/home/dblank/Desktop/Blank_Family/Blank Family/"
语言 = "fr"
```

选项
------------

* --site-dir=PATH - gPrime 网站目录的目录（必需）
* --config-file=FILE - 这些选项的配置文件（可选）
* --sitename="站点名称" - 用于站点的名称（可选，默认为 "gPrime"）
* --language=LANG_CODE - 用于显示网页的语言代码（例如，"fr"）（默认为 "en"，英语）
* --create=TREE-NAME - 使用 --site-dir 创建站点目录和家族树数据库，并指定 TREE-NAME
* --add-user=USERNAME - 添加用户名和密码；如果没有给出 --password，将提示输入密码
* --remove-user=USERNAME - 从 "SITE-DIR/passwd" 文件中删除用户的用户名和密码
* --change-password=USERNAME - 更改用户的密码；如果没有给出 --password，将提示输入密码
* --password=PASSWORD - 与 --change-password 或 --add-user 一起使用（此选项不推荐使用）
* --import-file=FILENAME - 导入 Gramps 支持的文件类型（.ged、.gramps、.json 等）
* --port=PORT-NUMBER - 监听的端口（默认为 8000）
* --hostname=LOCALHOST - 监听的主机名（默认为 "localhost"）
* --server=True|False - 启动服务器？默认为 True
* --open-browser=True|False - 启动时打开网页浏览器？
* --debug=True|False - 用于查看额外的调试信息；对开发有用（自动重启服务器）
* --xsrf=True/False - 使用跨站请求伪造保护（推荐）
* --help - 列出额外的选项和详细信息

常见变体
-----------------

```
python3 -m gprime.app --create="Smith Family" --site-dir="gprime_folder"

python3 -m gprime.app --site-dir="gprime_folder" --import-file="myinfo.gramps"

python3 -m gprime.app --site-dir="/path/to/gprime_folder"

python3 -m gprime.app --help
```