Event type plugins

Type	betty.ancestry.event_type.EventType
Repository	betty.project.Project.event_type_repository

Event types are used to indicate the type of an Event, such as a birth, a death, or an marriage.

Creating an event type

1. Create a new class that extends betty.ancestry.event_type.EventType and implements the abstract methods, for example:

   from typing import override
   from betty.ancestry.event_type import EventType
   from betty.machine_name import MachineName
   
   class MyEventType(EventType):
     @override
     @classmethod
     def plugin_id(cls) -> MachineName:
         return "my-module-my-event-type"
   
     # Implement remaining abstract methods...
     ...
   

2. Tell Betty about your event type by registering it as an entry point. Given the event type above in a module my_package.my_module, add the following to your Python package:

pyproject.toml

[project.entry-points.'betty.event_type']
'my-module-my-event-type' = 'my_package.my_module.MyEventType'

setup.py

SETUP = {
    'entry_points': {
        'betty.event_type': [
            'my-module-my-event-type=my_package.my_module.MyEventType',
        ],
    },
}
if __name__ == '__main__':
    setup(**SETUP)

See also

Read more about how to use event types and Betty’s built-in event types at Event Type.