Skip to content

Latest commit

 

History

History
325 lines (248 loc) · 13.5 KB

README.md

File metadata and controls

325 lines (248 loc) · 13.5 KB
Raw

Betty 👵

Test status Code coverage PyPI releases Supported Python versions Recent downloads Follow Betty on Twitter

Betty helps you visualize and publish your family history by building interactive genealogy websites out of your Gramps and GEDCOM family trees.

Table of Contents

Features

Betty generates static sites from your genealogy records. This means that once your site has been generated, you will not need any special software to publish it. It's fast and secure.

  • Builds pages for people, places, events, and media.
  • Renders interactive maps.
  • Fully multilingual: localize the site to one or more languages of your choice.
  • Responsive, and mobile- and touch-friendly interface.
  • Privacy and anonymization filters for living people.
  • View an example.

Installation

Requirements

  • Python 3.8+
  • Linux, Mac OS, or Windows

Instructions

Run pip install betty to install the latest stable release.

To install the latest development version, run pip install git+https://github.com/bartfeenstra/betty.git. If you want the latest source code, read the development documentation.

Usage

The command line

After installation, Betty can be used via the betty command:

Usage: betty [OPTIONS] COMMAND [ARGS]...

Options:
  -c, --configuration TEXT  The path to a Betty project configuration file.
                            Defaults to betty.json|yaml|yml in the current
                            working directory. This will make additional
                            commands available.
  --version                 Show the version and exit.
  --help                    Show this message and exit.

Commands:
  clear-caches  Clear all caches.
  demo          Explore a demonstration site.
  gui           Open Betty's graphical user interface (GUI).
  generate      Generate a static site.
  serve         Serve a generated site.

Configuration files

Configuration files are written in YAML (*.yaml or *.yml) or JSON (*.json):

base_url: https://ancestry.example.com
debug: true
root_path: /betty
clean_urls: true
title: Betty's ancestry
author: Bart Feenstra
lifetime_threshold: 125
locales:
  - locale: en-US
    alias: en
  - locale: nl
entity_types:
  Person:
    generate_html_list: true
  File:
    generate_html_list: false
extensions:
  betty.anonymizer.Anonymizer: {}
  betty.cleaner.Cleaner: {}
  betty.cotton_candy.CottonCandy:
    configuration:
      primary_inactive_color: '#ffc0cb'
      primary_active_color: '#ff69b4'
      link_inactive_color: '#149988'
      link_active_color: '#2a615a'
      featured_entities:
        - entity_type: Person
          entity_id: P123
        - entity_type: Place
          entity_id: Amsterdam
  betty.deriver.Deriver: {}
  betty.gramps.Gramps:
    configuration:
      family_trees:
        - file: ./gramps.gpkg
  betty.http_api_doc.HttpApiDoc: {}
  betty.maps.Maps: {}
  betty.privatizer.Privatizer: {}
  betty.trees.Trees: {}
  betty.wikipedia.Wikipedia: {}

  • base_url (required): The absolute, public URL at which the site will be published.

  • debug (optional): true to output more detailed logs and disable optimizations that make debugging harder. Defaults to false.

  • root_path (optional): The relative path under the public URL at which the site will be published.

  • clean_urls (optional): A boolean indicating whether to use clean URLs, e.g. /path instead of /path/index.html. Defaults to false.

  • content_negotiation (optional): Enables dynamic content negotiation, but requires a web server that supports it. This implies clean_urls. Defaults to false

  • title (optional): The site's title.

  • author (optional): The site's author and copyright holder.

  • lifetime_threshold (optional); The number of years people are expected to live at most, e.g. after which they're presumed to have died. Defaults to 125.

  • locales (optional); An array of locales, each of which is an object with the following keys:

    • locale(required): An IETF BCP 47 language tag.
    • alias (optional): A shorthand alias to use instead of the full language tag, such as when rendering URLs.

    If no locales are defined, Betty defaults to US English.

  • entity_types (optional): Keys are entity type names, and values are objects containing the following keys:

    • generate_html_list (optional): Whether to generate the HTML page to list entities of this type. Defaults to false.

  • extensions (optional): The extensions to enable. Keys are extension names, and values are objects containing the following keys:

    • enabled (optional): A boolean indicating whether the extension is enabled. Defaults to true.
    • configuration (optional): An object containing the extension's own configuration, if it provides any configuration options.

    Both keys may be omitted to quickly enable an extension using its default configuration.

    The extensions that ship with Betty, and their configuration:

    • betty.anonymizer.Anonymizer (optional): Removes personal information from private people. It provides no configuration options.
    • betty.cotton_candy.CottonCandy (optional): Configuration:
      • primary_inactive_color (optional): The case-insensitive hexadecimal code for the primary color. Defaults to #ffc0cb.
      • primary_active_color (optional): The case-insensitive hexadecimal code for the primary color for actively engaged elements. Defaults to #ff69b4.
      • link_inactive_color (optional): The case-insensitive hexadecimal code for the link color. Defaults to #149988.
      • link_active_color (optional): The case-insensitive hexadecimal code for the color of actively engaged links. Defaults to #2a615a.
      • featured_entities (optional): A list of entities to feature on the front page. Each item has the following configuration:
        • entity_type (required): The name of the entity type to feature, e.g. Person.
        • entity_id (required): The ID of the entity type to feature, e.g. P123.
    • betty.cleaner.Cleaner (optional): Removes data (events, media, etc.) that have no relation to any people. It provides no configuration options.
    • betty.demo.Demo (optional): Loads demonstrative content and functionality that shows what Betty can do. It provides no configuration options.
    • betty.deriver.Deriver (optional): Extends ancestries by deriving facts from existing information. It provides no configuration options.
    • betty.gramps.Gramps (optional): Loads Gramps family trees. Configuration:
      • family_trees (required): An array defining zero or more Gramps family trees to load. Each item is an object with the following keys:
        • file (required): the path to a Gramps XML or Gramps XML Package file.
    • betty.http_api_doc.HttpApiDoc (optional): Renders interactive and user-friendly HTTP API documentation using ReDoc.
    • betty.maps.Maps (optional): Renders interactive maps using Leaflet.
    • betty.privatizer.Privatizer (optional): Marks living people private. Configuration: {}.
    • betty.trees.Trees (optional): Renders interactive ancestry trees using Cytoscape.js.
    • betty.wikipedia.Wikipedia (optional): Lets templates and other extensions retrieve complementary Wikipedia entries.

Translations

Betty ships with the following translations:

  • US English (en-US)
  • Dutch (nl-NL)
  • French (fr-FR)
  • Ukrainian (uk)

Extensions and sites can override these translations, or provide translations for additional locales.

Gramps

Privacy

Gramps has limited built-in support for people's privacy. To fully control privacy for people, as well as events, files, sources, and citations, add a betty:privacy attribute to any of these types, with a value of private to explicitly declare the data always private or public to declare the data always public. Any other value will leave the privacy undecided, as well as person records marked public using Gramps' built-in privacy selector. In such cases, the betty.privatizer.Privatizer extension may decide if the data is public or private.

Dates

For unknown date parts, set those to all zeroes and Betty will ignore them. For instance, 0000-12-31 will be parsed as "December 31", and 1970-01-00 as "January, 1970".

Event types

Betty supports the following custom Gramps event types:

  • Correspondence
  • Funeral
  • Missing
  • Will

Event roles

Betty supports the following custom Gramps event roles:

  • Beneficiary

Order & priority

The order of lists of data, or the priority of individual bits of data, can be automatically determined by Betty in multiple different ways, such as by matching dates, or locales. When not enough details are available, or in case of ambiguity, the original order is preserved. If only a single item must be retrieved from the list, this will be the first item, optionally after sorting.

For example, if a place has multiple names (which may be historical or translations), Betty may try to filter names by the given locale and date, and then indiscriminately pick the first one of the remaining names to display as the canonical name.

Tips:

  • If you want one item to have priority over another, it should come before the other in a list (e.g. be higher up).
  • Items with more specific or complete data, such as locales or dates, should come before items with less specific or complete data. However, items without dates at all are considered current and not historical.
  • Unofficial names or nicknames, should generally be put at the end of lists.

GEDCOM files

To build a site from your GEDCOM files:

  1. Install and launch Gramps
  2. Create a new family tree
  3. Import your GEDCOM file under Family Trees > Import...
  4. Export your family tree under Family Trees > Export...
  5. As output format, choose one of the Gramps XML options
  6. Follow the documentation to configure your Betty site to load the exported file

The Python API

from betty.app import App
from betty.asyncio import sync
from betty.generate import generate
from betty.load import load


@sync
async def generate():
    with App() as app:
        await load(app)
        await generate(app)

Development

First, fork and clone the repository, and navigate to its root directory.

Requirements

  • The installation requirements documented earlier.
  • Node.js
  • Bash (you're all good if which bash outputs a path in your terminal)

Installation

In any existing Python environment, run ./bin/build-dev.

Working on translations

Making changes to the translatable strings in the source code

Run ./bin/extract-translatables to update the translations files with the changes you made.

Adding translations for a language for which no translations exist yet

Run ./bin/init-translation $locale where $locale is a IETF BCP 47, but using underscores instead of dashes (nl_NL instead of nl-NL).

Updating the translations for a language

First, install a PO file editor on your system. Any will do, but if you don't want to search for one, Poedit is a good and free editor to start with.

Then, with this PO file editor, open and change the *.po file for the translations you want to change. For Dutch (Netherlands), that is ./betty/assets/locale/nl_NL/LC_MESSAGES/betty.po, for example.

Testing

In any existing Python environment, run ./bin/test.

Fixing problems automatically

In any existing Python environment, run ./bin/fix.

Contributions 🥳

Betty is Free and Open Source Software. As such you are welcome to report bugs or submit improvements.

Copyright & license

Betty is copyright Bart Feenstra and contributors, and released under the GNU General Public License, Version 3. In short, that means you are free to use Betty, but if you distribute Betty yourself, you must do so under the exact same license, provide that license, and make your source code available.