gedcom-x 0.5.5__py3-none-any.whl → 0.5.7__py3-none-any.whl

gedcom_x-0.5.7.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: gedcom-x
+Version: 0.5.7
+Summary: Python implimentation of gedcom-x standard
+Author-email: "David J. Cartwright" <davidcartwright@hotmail.com>
+License: MIT
+Keywords: gedcom,gedcomx,ged
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Utilities
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Dynamic: requires-python
+
+# GEDCOM-X Python Toolkit (gedcom-x beta 0.5.5)
+
+A lightweight, class-based Python implementation of the [GEDCOM-X data model](https://github.com/FamilySearch/gedcomx).  
+
+## ⚠️ Project Status
+
+This project is currently in **beta**.  
+While the core GEDCOM-X classes and serialization are functional, some features may not be fully implemented or may not behave exactly as expected.  
+
+- Certain GEDCOM 7 tags are not yet mapped  
+- Some classes may be missing methods or fields  
+- Error handling and validation are still evolving  
+- Backward compatibility is **not guaranteed** until the first stable release  
+
+### ✅ What You Can Do
+- Create and manipulate GEDCOM-X objects in Python  
+- Serialize and deserialize data to/from JSON  
+- Experimentally convert GEDCOM 5x & 7 files into GEDCOM-X JSON  
+- Extend the classes to handle new GEDCOM tags or custom attributes  
+- Use the library as a foundation for genealogy-related tooling or RAG pipelines  
+
+### ❌ What You Can’t Do (Yet)
+- Rely on complete coverage of all GEDCOM 7 tags  
+- Expect perfect compliance with the GEDCOM-X specification  
+- Assume strong validation or error recovery on malformed input  
+- Use it as a drop-in replacement for production genealogy software  
+- Write GEDCOM-X to GEDCOM 5x / 7
+- Create Graphs from Genealogies
+
+Contributors and testers are welcome — feedback will help stabilize the library!
+
+---
+
+This library aims to provide:
+
+- Python classes for every GEDCOM-X type (Person, Fact, Source, etc.)
+- Extensibility, with current GEDCOM RS etc, extension built in
+- Serialization and Deserialization to/from GEDCOM-X JSON
+- Utilities to convert GEDCOM 5x & 7 GEDCOM Files into GEDCOM-X and back
+- Type-safe field definitions and extensibility hooks for future tags
+
+---
+
+## Features
+
+- **Complete GEDCOM-X Class Coverage**  
+  Each GEDCOM-X type is represented as a Python class with fields and types.
+
+- **Serialization / Deserialization**  
+  Every class can serialize to JSON and reconstruct from JSON via `_as_dict_()` and `_from_json()` methods.
+
+- **Type Checking & Enum Validation**  
+  Uses Python type hints and enums to ensure correct values (e.g. FactType, EventType, ConfidenceLevel).
+
+- **Composable / Nestable Classes**  
+  Nested objects (e.g. Person → Name → NameForm → TextValue) are constructed and validated recursively.
+
+- **GEDCOM 7 → GEDCOM-X Conversion**  
+  Experimental parser to read GEDCOM 7 files and convert them into structured GEDCOM-X JSON.
+
+---
+
+## Installation
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/yourusername/gedcom-x.git
+cd gedcom-x
+pip install -r requirements.txt
+```
+or
+```
+pip install gedcom-x
+```
+---
+
+## Examples
+
+<details>
+
+<summary>Create a Person Gedcom-X Type</summary>
+
+```python
+import json
+from gedcomx import Person, Name, NameForm, TextValue
+
+person = Person(
+    id="P-123",
+    names=[Name(
+        nameForms=[NameForm(
+            fullText=TextValue(value="John Doe")
+        )]
+    )]
+)
+
+print(json.dumps(person._as_dict_,indent=4))
+```
+result
+```text
+{
+    "id": "P-123",
+    "lang": "en",
+    "private": false,
+    "living": false,
+    "gender": {
+        "lang": "en",
+        "type": "http://gedcomx.org/Unknown"
+    },
+    "names": [
+        {
+            "lang": "en",
+            "nameForms": [
+                {
+                    "lang": "en",
+                    "fullText": {
+                        "lang": "en",
+                        "value": "John Doe"
+                    }
+                }
+            ]
+        }
+    ]
+}
+
+</details>

gedcom_x-0.5.7.dist-info/RECORD

@@ -0,0 +1,49 @@
+gedcomx/Address.py,sha256=HPh-YZEkcxhzGGUxDWrrmAvKsyL__RthMJl6vXcMA80,4865
+gedcomx/Agent.py,sha256=u7zIr6SNYREDhceOkj09uS6zjl3RXbix5QlQB7mxjz4,8844
+gedcomx/Attribution.py,sha256=JESWw3U_momYDkQ6vknvaAW9DdIWwRRdQJwdD0UPAEI,3381
+gedcomx/Conclusion.py,sha256=9VWEu6lphB0Y8L3YH3t2QcXt5xW5NdnSKXpa9eujU30,8781
+gedcomx/Converter.py,sha256=aM8i8qIhzc9pJ3k75hFQSBkeRax2brucTefPYxENQHI,50968
+gedcomx/Coverage.py,sha256=VR_lQDUgJ9rI-hHzOA8GxS_I1C_Du_3SvG57dzulXNI,1361
+gedcomx/Date.py,sha256=I11mm2YEqUenxt-skphCHO-GWKPQrpMomOL_Utapzy0,2344
+gedcomx/Document.py,sha256=DjL3HwpyCF9cOCdvpvrLu4Mxp7ZIYT1AkQEJGB3TSjY,2967
+gedcomx/Event.py,sha256=j34nM5pZcmfSthdI87be6cGKGemHJky5xVaajmeSVK4,13321
+gedcomx/EvidenceReference.py,sha256=WXZpmcKzwb3lYQmGVf-TY2IsbNG3fIInPY1khRjtOSg,348
+gedcomx/Exceptions.py,sha256=0OdPM3euhBMgX8o61ZwPuKeN8zPuSuuDcSBFflVGFqk,587
+gedcomx/ExtensibleEnum.py,sha256=DftCZLMBNul3C9hwh-rf0GE3SVdvylvyd5mt7bX_l6o,6535
+gedcomx/Fact.py,sha256=r1Ct96moCIXCAd24Ho2aLCI12PGH2AoKIyjACtJT7go,24458
+gedcomx/Gedcom.py,sha256=l_BuLBynQacDtpLjhs2Afrabfiqt2Opoo_5_7myI7Z4,1709
+gedcomx/Gedcom5x.py,sha256=lbIEvK3h2b-IJoO9Fgmq_qc3nItzB_qTonqLafxYfXk,23137
+gedcomx/GedcomX.py,sha256=p0PeJqS4bKXGsXY487JOdGNK4vIwARX7YeTDIqPeNNw,19000
+gedcomx/Gender.py,sha256=vBkYJqhf1mN58Wrw9MvhbVJDNw1pM4-ktFW6mYja_Rw,2285
+gedcomx/Group.py,sha256=VNI_cI_-YnJ9cHzwMmHD8qwDNMe89kEocPuQ67rwStA,1606
+gedcomx/Identifier.py,sha256=1uhNO4Ll-_xLyVM-IYdywz7wTEwHEH44xx4JQId9F9c,8491
+gedcomx/Logging.py,sha256=vBDOjawVXc4tCge1laYjy6_2Ves-fnGzG0m6NnLZejE,624
+gedcomx/LoggingHub.py,sha256=f4z1r6WL3TdL1kg1eaCfCk7XEn9epCH5zUCXd1OT4mc,7793
+gedcomx/Mutations.py,sha256=wtmoaiVS9Vw7Dzpfq34VQETBAVFvQnIlD5rbtSTopfs,6314
+gedcomx/Name.py,sha256=esVS1nqvo5F5ggKQhnW4DYvww_hjXQF91oayLGG4LuU,18661
+gedcomx/Note.py,sha256=hCwLDJYEQ-kR1-3rknHTx_nLq6ytBzi23sQukD8HHlg,2547
+gedcomx/OnlineAccount.py,sha256=P24o98IXo_8XQoICYZPgALjdzS0q8t2l4DU3Od9KxyI,291
+gedcomx/Person.py,sha256=tygyfHWqhbrH3z7TKPAyjJK14M7qu04mCGgXMgi7J_g,8057
+gedcomx/PlaceDescription.py,sha256=oUih1T8jsUVcxdevPGuFpQOc34t4HoYc9ldr87ZH0IA,5591
+gedcomx/PlaceReference.py,sha256=20HmaQUAlPrTjsra38j22NBsNqDBnvHZ5NuP6YzlizA,2111
+gedcomx/Qualifier.py,sha256=iivgraoayJTYZUlkbSAKPzQ7msPYpBvTlmsEsXxz3zw,1778
+gedcomx/Relationship.py,sha256=Et_72kRohBmWpWra2fS_-ha0YvEDZTZqkoD8HrerQW0,3693
+gedcomx/Resource.py,sha256=HIOoKlVZtEp13j7sn4xkqRwRrYadqpiXswKpdJRe2Ns,2674
+gedcomx/Serialization.py,sha256=ZIECHrG-PRZuS2SHGtfv1eg_2Rt-PHPbz4ivF7eH4p8,34041
+gedcomx/SourceCitation.py,sha256=aW-lEb7bT9QU49GiBjJppFMBvtisR6fhVVuXjr5y4vQ,742
+gedcomx/SourceDescription.py,sha256=yUBJXsn64OL0MAWSc3QPWrLt8RKYa1omGGp0FOLo-n8,14929
+gedcomx/SourceReference.py,sha256=d5kNxqalCFlbRWD2kSJAMCexOrH_s1oXu9y_RUmCGa0,5189
+gedcomx/Subject.py,sha256=2xPZiNjZDYSwLkloUPKDRa7F8_ql5zYMFJLS_9ayUtk,2609
+gedcomx/TextValue.py,sha256=6B0wMxL0nigFNzhXZDhbTONvFGbnM2t2NcDZiZuu4Zw,1112
+gedcomx/TopLevelTypeCollection.py,sha256=nvTO6GwFwEZk9jX4fVqhy75ygsshomNb20tnlExKqyY,1495
+gedcomx/Translation.py,sha256=TZZTfuzjsx2glnUJwPrs0TrrShvLjygYUQ6cxhZXnMc,61398
+gedcomx/URI.py,sha256=AuIECTwHUkp-2z0Q9iuA3Me1PiawFKZKCR4sAA64FE8,4270
+gedcomx/Zip.py,sha256=lBxcv-Vip45884EHj56wZJJ5I36Q38UuHUidDxQBoS8,14
+gedcomx/__init__.py,sha256=DfKVj46fhYtpM45NZnK333iDpt2WQ1XJXWsLcVCARNo,1704
+gedcomx/Extensions/__init__.py,sha256=MQzi_whzlxiLiknUNh10hG8OVrNqJE38l6n-AwCssx8,24
+gedcomx/Extensions/rs10/__init__.py,sha256=nSHoZiD8hsCAyE-KyRTuWSLqSJSFh12kSz7hqilAMps,26
+gedcomx/Extensions/rs10/rsLink.py,sha256=uVmdTJl_atheO-pRpP3a5uUrazudf4R_tZvWSZIQdNk,4353
+gedcom_x-0.5.7.dist-info/METADATA,sha256=bLAwaXozcWmQ0blAY2igIeEa3Lh-gQjX7NiPHuGESNs,4332
+gedcom_x-0.5.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gedcom_x-0.5.7.dist-info/top_level.txt,sha256=smVBF4nxSU-mzCd6idtRYTbYjPICMMi8pTqewEmqF8Y,8
+gedcom_x-0.5.7.dist-info/RECORD,,

gedcomx/Address.py

@@ -1,7 +1,7 @@
 from typing import Optional
 import json
 
-from .Serialization import Serialization
+
 
 class Address:
     """A GedcomX Address Data Type
@@ -113,18 +113,18 @@ class Address:
     
     @property
     def _as_dict_(self):
-        type_as_dict =  {
-            "city": self.city if self.city else None,
-            "country": self.country if self.country else None,
-            "postalCode": self.postalCode if self.postalCode else None,
-            "stateOrProvince": self.stateOrProvince if self.stateOrProvince else None,
-            "street": self.street if self.street else None,
-            "street2": self.street2 if self.street2 else None,
-            "street3": self.street3 if self.street3 else None,
-            "street4": self.street4 if self.street4 else None,
-            "street5": self.street5 if self.street5 else None,
-            "street6": self.street6 if self.street6 else None
-        }
+        from .Serialization import Serialization
+        type_as_dict = {}
+        if self.city: type_as_dict["city"] = self.city
+        if self.country: type_as_dict["country"] = self.country
+        if self.postalCode: type_as_dict["postalCode"] = self.postalCode
+        if self.stateOrProvince: type_as_dict["stateOrProvince"] = self.stateOrProvince
+        if self.street: type_as_dict["street"] = self.street
+        if self.street2: type_as_dict["street2"] = self.street2
+        if self.street3: type_as_dict["street3"] = self.street3
+        if self.street4: type_as_dict["street4"] = self.street4
+        if self.street5: type_as_dict["street5"] = self.street5
+        if self.street6: type_as_dict["street6"] = self.street6
 
         return Serialization.serialize_dict(type_as_dict)
 

gedcomx/Agent.py

@@ -11,7 +11,7 @@ from .OnlineAccount import OnlineAccount
 from .TextValue import TextValue
 from .Resource import Resource
 from .URI import URI
-from .Serialization import Serialization
+
 
 
 class Agent:
@@ -82,9 +82,10 @@ class Agent:
         self.emails = emails or []
         self.phones = phones or []
         self.addresses = addresses if addresses else []
-        self.xnotes = []
+        self.person = person
+        self.notes = []
         self.attribution = attribution or None
-        self.uri = URI(fragment=self.id)
+        self.uri = URI(fragment=self.id) if self.id else None
   
     def _append_to_name(self, text_to_append: str):
         if self.names and self.names[0] and self.names[0].value:
@@ -113,7 +114,7 @@ class Agent:
         else:
             raise ValueError(f'name must be of type str or TextValue, recived {type(name_to_add)}')
     
-    def add_note(self, note_to_add: 'Note'):
+    def add_note(self, note_to_add):
         from .Note import Note
         if note_to_add and isinstance(note_to_add,Note):
             self.xnotes.append(note_to_add)
@@ -125,18 +126,29 @@ class Agent:
     
     @property
     def _as_dict_(self):
-        type_as_dict = {
-            "id": self.id if self.id else None,
-            "identifiers": self.identifiers._as_dict_ if self.identifiers else None,
-            "names": [name._as_dict_ for name in self.names],
-            "homepage": self.homepage if self.homepage else None,
-            "openid": self.openid if self.openid else None,
-            "accounts": self.accounts if self.accounts else None,
-            "emails": self.emails if self.emails else None,
-            "phones": self.phones if self.phones else None,
-            "addresses": [address._as_dict_ for address in self.addresses],
-            "notes": [note._as_dict_ for note in self.xnotes]
-        }
+        from .Serialization import Serialization
+        type_as_dict = {}
+
+        if self.id:
+            type_as_dict["id"] = self.id
+        if self.identifiers:
+            type_as_dict["identifiers"] = self.identifiers._as_dict_
+        if self.names:
+            type_as_dict["names"] = [name._as_dict_ for name in self.names if name]
+        if self.homepage:
+            type_as_dict["homepage"] = self.homepage
+        if self.openid:
+            type_as_dict["openid"] = self.openid
+        if self.accounts:
+            type_as_dict["accounts"] = self.accounts
+        if self.emails:
+            type_as_dict["emails"] = self.emails
+        if self.phones:
+            type_as_dict["phones"] = self.phones
+        if self.addresses:
+            type_as_dict["addresses"] = [address._as_dict_ for address in self.addresses if address]
+        if self.notes:
+            type_as_dict["notes"] = [note._as_dict_() for note in self.notes if note]
         return Serialization.serialize_dict(type_as_dict)
     
     @classmethod

gedcomx/Attribution.py

@@ -2,9 +2,30 @@
 from datetime import datetime
 from typing import Optional, Dict, Any
 
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    Attribution.py
+ Author:  David J. Cartwright
+ Purpose: 
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-08-31: fixed _as_dict_ to deal with Resources and ignore empty fields
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+
 from .Agent import Agent
-from .Resource import Resource, get_resource_as_dict
-from .Serialization import Serialization
+from .Resource import Resource
+#=====================================================================
+
 
 class Attribution:
     """Attribution Information for a Genealogy, Conclusion, Subject and child classes
@@ -39,12 +60,18 @@ class Attribution:
         """
         Serialize Attribution to a JSON-ready dict, skipping None values.
         """
+        from Serialization import Serialization
         type_as_dict: Dict[str, Any] = {}
-        type_as_dict['contributor'] = get_resource_as_dict(self.contributor)       
-        type_as_dict['modified'] = self.modified if self.modified else None
-        type_as_dict['changeMessage'] = self.changeMessage if self.changeMessage else None 
-        type_as_dict['creator'] = get_resource_as_dict(self.creator)         
-        type_as_dict['created'] = self.created if self.created else None
+        if self.contributor:
+            type_as_dict['contributor'] = Resource(target=self.contributor)._as_dict_  
+        if self.modified:     
+            type_as_dict['modified'] = self.modified if self.modified else None
+        if self.changeMessage:
+            type_as_dict['changeMessage'] = self.changeMessage if self.changeMessage else None 
+        if self.creator:
+            type_as_dict['creator'] = Resource(target=self.creator)._as_dict_   
+        if self.created:      
+            type_as_dict['created'] = self.created if self.created else None
                     
         return Serialization.serialize_dict(type_as_dict)
 

gedcomx/Conclusion.py

@@ -8,7 +8,7 @@ from .Attribution import Attribution
 #from .Document import Document
 from .Note import Note
 from .Qualifier import Qualifier
-from .Serialization import Serialization
+
 from .SourceReference import SourceReference
 from .Resource import Resource, URI
 from .Extensions.rs10.rsLink import _rsLinkList, rsLink
@@ -96,7 +96,7 @@ class Conclusion:
     Args:
         id (str, optional): A unique identifier for the conclusion. If not provided, 
             a UUID-based identifier will be automatically generated.
-        lang (str, optional): The language code of the conclusion. Defaults to 'en'.
+        lang (str, optional): The language code of the conclusion. 
         sources (list[SourceReference], optional): A list of source references that 
             support the conclusion.
         analysis (Document | Resource, optional): A reference to an analysis document 
@@ -127,7 +127,7 @@ class Conclusion:
     
     def __init__(self,
                  id: Optional[str] = None,
-                 lang: Optional[str] = 'en',
+                 lang: Optional[str] = None,
                  sources: Optional[List[SourceReference]] = None,
                  analysis: Optional[object | Resource] = None,
                  notes: Optional[List[Note]] = None,
@@ -188,16 +188,27 @@ class Conclusion:
     
     @property
     def _as_dict_(self):
-        type_as_dict = {
-            'id':self.id,
-            'lang':self.lang,
-            'sources': [source._as_dict_ for source in self.sources] if self.sources else None,
-            'analysis': self.analysis if self.analysis else None,
-            'notes': [note for note in self.notes] if self.notes else None,
-            'confidence':self.confidence,
-            'attribution':self.attribution,
-            'links':self.links._as_dict_ if self.links else None
-        }
+        from .Serialization import Serialization
+        type_as_dict = {}
+
+        if self.id:
+            type_as_dict['id'] = self.id
+        if self.lang:
+            type_as_dict['lang'] = self.lang
+        if self.sources:
+            type_as_dict['sources'] = [s._as_dict_ for s in self.sources if s]
+        if self.analysis:
+            type_as_dict['analysis'] = getattr(self.analysis, '_as_dict_', self.analysis)
+        if self.notes:
+            type_as_dict['notes'] = [
+                (n._as_dict_ if hasattr(n, '_as_dict_') else n) for n in self.notes if n
+            ]
+        if self.confidence is not None:
+            type_as_dict['confidence'] = self.confidence
+        if self.attribution:
+            type_as_dict['attribution'] = getattr(self.attribution, '_as_dict_', self.attribution)
+        if self.links:
+            type_as_dict['links'] = self.links._as_dict_
       
         return Serialization.serialize_dict(type_as_dict)