Skip to main content

Family tree static site generator for Gramps databases

Project description

greatgramps

A static site generator for Gramps family tree databases.

greatgramps reads a Gramps database and builds a browsable static website from it. Each person in the tree gets their own page with biographical details, family relationships, events, photos, and a relationship label showing how they connect to a chosen root person. The site also includes index pages for people, places, events, census records, birthdays, and surnames.

The site is built from the point of view of one or more root people — typically the living members of a family who each want to browse the tree as themselves. Each root person gets their own section of the site where relationship labels ("your grandmother", "your 2nd cousin") are calculated relative to them. A dropdown in the nav bar lets you switch between roots from any page.

The site is generated once and served as plain HTML — no server-side code required. It's not a web frontend for Gramps (like gramps-web), in that it's read-only, but it produces a rich browsable site for your tree. Once built, the site can be hosted with ease, with no Python or Gramps installation required.

This approach lets you manage your own tree using open source software without relying on subscription or proprietary services, while still making it easy to share your tree with your family on the web.

Demo

A demo is available at gramps.bennuttall.com which features a generated family tree showcasing what greatgramps can build from a Gramps database.

Requirements

  • Python 3.10+
  • A Gramps sqlite database
  • Gramps

Installation

Install Gramps first. See the Gramps installation instructions.

Also install PyICU for locale-aware sorting, via your platform's package manager (otherwise Gramps logs a warning and falls back to less accurate sorting of names and places). On Debian/Ubuntu:

sudo apt install python3-icu

Then install the project. The core package only handles reading the Gramps database; pick the extras for the features you need:

pip install greatgramps[cli,html,pdf]
  • cli — the grgr command-line tool
  • html — the grgr build / grgr rebuild-page commands for generating the static site
  • pdf — the grgr pdf commands (also requires Ghostscript)

If you only have the html extra installed (no cli), build the site with python -m greatgramps.build instead of grgr build — it has no dependency on typer or rich.

Links

Licence

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

greatgramps-0.3.8.tar.gz (74.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

greatgramps-0.3.8-py3-none-any.whl (101.4 kB view details)

Uploaded Python 3

File details

Details for the file greatgramps-0.3.8.tar.gz.

File metadata

  • Download URL: greatgramps-0.3.8.tar.gz
  • Upload date:
  • Size: 74.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for greatgramps-0.3.8.tar.gz
Algorithm Hash digest
SHA256 fc98e99ee15e9126ab625bf2e6f84eaca3326ce25273a72899fae448811f1c24
MD5 b40b081d993205471f580753c69e04c7
BLAKE2b-256 6d032e6138db1af600cfb798733bb354473f07ac48a35b89e301b26d6b23969a

See more details on using hashes here.

File details

Details for the file greatgramps-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: greatgramps-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 101.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for greatgramps-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4efb694faea9b69e88e1cfe1bb2df6ea6aa3e6082ea1e046c905bfcab6f68a9a
MD5 0d342c4dd88ecbe961f221f7874d2cc5
BLAKE2b-256 d65efea7a7d682c1d5091eb17a8f1cf3d7260b24f86af512856445eeeedc447a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page