Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vokimon/nissaga
Genealogy tree builder from simple yaml files (kingraph python clone with extensions)
https://github.com/vokimon/nissaga
Last synced: 2 months ago
JSON representation
Genealogy tree builder from simple yaml files (kingraph python clone with extensions)
- Host: GitHub
- URL: https://github.com/vokimon/nissaga
- Owner: vokimon
- License: agpl-3.0
- Created: 2021-09-11T08:29:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T09:48:27.000Z (5 months ago)
- Last Synced: 2024-10-24T20:06:13.901Z (3 months ago)
- Language: Python
- Size: 1.39 MB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Nissaga, genealogy tree generator
[](https://github.com/vokimon/nissaga/actions/workflows/main.yml)
[](https://coveralls.io/r/vokimon/nissaga)
[](https://pypi.org/project/nissaga/)
[](https://www.gnu.org/licenses/agpl-3.0)
[](https://pypi.org/project/nissaga/)
Nissaga is a tool to generate genealogy trees
from a simple data description in [YAML](https://en.wikipedia.org/wiki/YAML).
It is an extended rewrite in Python of the JavaScript tool [kingraph].
'Nissaga' is [a catalan word meaning _lineage_](https://en.wiktionary.org/wiki/nissaga).
## Installation
```bash
pip install nissaga
```
You need to install [graphviz]. Not the python wrapper library, but the program itself.
[kingraph]: https://github.com/rstacruz/kingraph
[graphviz]: https://graphviz.org
## Usage
```bash
nissaga draw myfamily.yaml
```
This generates a file `myfamily.pdf`
You can specify a second parameter to choose the output format: png, svg or any supported by graphviz.
```bash
nissaga draw myfamily.yaml svg
```
Get more information on the [command line documentation](docs/cli.md).
## Input file
The input file follows this [Schema](nissaga-schema.json) documented [here](docs/inputformat.md)
A simple example:
```yaml
people:
me:
fullname: Alférez Boye, Carmen
born: 1988-06-12
sis:
fullname: Alférez Boye, Diana
born: 1985-07-04
dad:
fullname: Alférez Esquerra, Fran
born: 1957-03-23
mom:
fullname: Boye Gener, Hipatia
born: 1951-10-28
dadgranpa:
fullname: Boye Isidro, Javier
born: 1932-07-22
died: 2013-03-19
dadgranma:
fullname: Gener Krahe, Laura
born: 1933-02-12
died: 2017-09-19
momgranpa:
fullname: Alférez Miró, Natanael
born: 1944-04-15
momgranma:
fullname: Esquerra Olivera, Pandora
born: 1931-01-13
died: 2007-05-19
families:
- parents: [mom, dad]
children: [sis, me]
- parents: [dadgranma, dadgranpa]
children: [dad]
- parents: [momgranma, momgranpa]
children: [mom]
```
## Differences with kingraph
This application was started as a clone of the functionality of [kingraph]
to overcome performance and scalability problems with big trees,
and also to extend its functionality.
So, it is mostly back compatible with kingraph format.
The following kingraph features are not supported:
- `family.children2` and `family.parents2` relations are not yet supported
The following features have been introduced by nissaga, and are not available in kingraph (but the yaml would be still compatible).
- Rich **person boxes** with dates, photos and separated first name and surname.
- `person.born` maybe set to a date, and will appear as `*YYYY-MM-DD` bellow the person's name.
- `person.died` maybe set to a date or true and will appear as `+YYYY-MM-DD` bellow the person's name.
- `person.age` age of dead, not used, just to keep track of it when that's the only data we have.
- `person.pics` is a list of pictures files relative to the yaml file. The first one will be added as person's face. The other pics are not used yet.
- Rich **unions** with marriage and divorce annotations
- `family.married`: defaults to true. Set it to false to indicate unmarried patnership (`⚯`). Set it to a date to see `⚭YYYY-MM-DD` in the union node.
- `family.divorced`: defaults to false. Set it to true to indicate a divorce (`⚮`). Set it to a date to see `⚮YYYY-MM-DD` in the union node.
- Attributes for **internal documentation**:
- `person.todo` a string or list of strings of pending tasks for the person
- `person.from` origin of the person (country, city...)
- `person.comments` a string or list of strings of comments
- `family.notes` a string or list of strings of notes
- `family.docs` documentation about the family. A list of document paths relative to the yaml file. Not used yet but it is suposed to provide links to the research sources.