motleydev / Family-Tree_mGrahl

This repository represents part 3 of my final exam at my school (CSH). It contains a Python development environment with an implementation of a graph data type representing a family tree.

Family Tree Python Project

Introduction

This Python project implements a simple family tree in a graph data structure that allows users to represent family relationships, query information about all family members as long as data is available, and save the family to a .csv or .json file. Due to the way it is implemented, it is recommended to use a .csv file. This file format takes up less space. However, it requires some conversion, which may result in longer run times.

Features

• Simple and extensible tree data structure.
• Addition of nodes to represent family members.
• Addition of n given generations.
• Search nodes by ID
• Retrieval of family information.
• Saving and loading family information in a .csv or .json file.

Requirements

• git or GitHub Desktop
• VS Code
• Docker

Getting Started

1. Clone this Repository:

   git:

   git clone https://github.com/mGrahlCSHegau/Family-Tree.git
   cd family-tree-python

   GitHub Desktop:

   > Open GitHub Desktop

   • File/ Clone Repository...
   • URL/ add this url: https://github.com/mGrahlCSHegau/Family-Tree.git
   • Choose a local path

2. Setup Developing environment

   >Open VSCode

   • >Dev Containers: Open Folder in Container

3. Usage

   >go to: /workspaces/Family-Tree/example_script.py

   • Run Code (Ctrl+Alt+N) or the Run (▶) button in the top right corner.