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

gedcomx/{Gender.py → gender.py}

@@ -1,18 +1,32 @@
 from enum import Enum
 from typing import List, Optional
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    gender.py
+ Author:  David J. Cartwright
+ Purpose: 
 
-from gedcomx.Attribution import Attribution
-from gedcomx.Conclusion import ConfidenceLevel
-from gedcomx.Note import Note
-from gedcomx.SourceReference import SourceReference
-from gedcomx.Resource import Resource
+ Created: 2025-08-25
+ Updated:
+   - 2025-08-31: 
+   
+======================================================================
+"""
 
-from .Conclusion import Conclusion
-from .Qualifier import Qualifier
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel, Conclusion
+from .note import Note
+from .resource import Resource
+from .source_reference import SourceReference
+#=====================================================================
 
 
-from collections.abc import Sized
-
 class GenderType(Enum):
     Male = "http://gedcomx.org/Male"
     Female = "http://gedcomx.org/Female"
@@ -48,7 +62,7 @@ class Gender(Conclusion):
     
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization    
+        from .serialization import Serialization    
         type_as_dict = super()._as_dict_  
         if self.type:
             type_as_dict['type'] = self.type.value if self.type else None                   
@@ -58,7 +72,7 @@ class Gender(Conclusion):
 
     @classmethod
     def _from_json_(cls,data):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         
         return Serialization.deserialize(data, Gender)
         

gedcomx/group.py

@@ -0,0 +1,63 @@
+from enum import Enum
+from typing import List, Optional
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    group.py
+ Author:  David J. Cartwright
+ Purpose: 
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-09-01: Updating basic structure, identify TODO s 
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .document import Document
+from .date import Date
+from .evidence_reference import EvidenceReference
+from .identifier import Identifier
+from .note import Note
+from .place_reference import PlaceReference
+from .source_reference import SourceReference
+from .resource import Resource
+
+from .textvalue import TextValue
+from .subject import Subject
+
+class GroupRoleType(Enum):                              #TODO Impliment
+    def __init__(self) -> None:
+        super().__init__()
+
+class GroupRole:                                        #TODO Impliment
+    identifier = 'http://gedcomx.org/v1/GroupRole'
+    version = 'http://gedcomx.org/conceptual-model/v1'
+
+    def __init__(self, person: Resource,type: Optional[Enum], date: Optional[Date],details: Optional[str]) -> None:
+        pass
+
+class Group(Subject):                                   #TODO Impliment
+    identifier = 'http://gedcomx.org/v1/Group'
+    version = 'http://gedcomx.org/conceptual-model/v1'
+
+    def __init__(self,
+                 id: str | None, lang: str | None,
+                 sources: List[SourceReference] | None,
+                 analysis: Document | Resource | None, notes: List[Note] | None, confidence: ConfidenceLevel | None, attribution: Attribution | None, extracted: bool | None, evidence: List[EvidenceReference] | None, media: List[SourceReference] | None, identifiers: List[Identifier] | None,
+                 names: List[TextValue],
+                 date: Optional[Date],
+                 place: Optional[PlaceReference],
+                 roles: Optional[List[GroupRole]]) -> None:
+        super().__init__(id, lang, sources, analysis, notes, confidence, attribution, extracted, evidence, media, identifiers)
+        self.names = names if names else []
+        self.date = date
+        self.place = place
+        self.roles = roles if roles else []

gedcomx/{Identifier.py → identifier.py}

@@ -5,9 +5,9 @@ from typing import List, Optional, Dict, Any
 
 from collections.abc import Iterator
 import json
-from .Resource import Resource
-from .URI import URI
-from .ExtensibleEnum import ExtensibleEnum
+from .resource import Resource
+from .uri import URI
+from .extensible_enum import ExtensibleEnum
 
 import secrets
 import string
@@ -51,7 +51,7 @@ class Identifier:
     
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = {}
         if self.values:
             type_as_dict["value"] = list(self.values)  # or [v for v in self.values]

gedcomx/{Mutations.py → mutations.py}

@@ -1,6 +1,29 @@
-from .Gedcom5x import Gedcom5xRecord
-from .Fact import Fact, FactType
-from .Event import Event, EventType
+
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    mutations.py
+ Author:  David J. Cartwright
+ Purpose: Objects used to convert TAGs/Structues/Types from GEDCOM Versions
+    when simple parsing will not work. (complex or ambiguous structures)
+
+ Created: 2025-08-25
+ Updated:
+   - 2025-08-31: cleaned up imports and documentation
+   - 2025-09-01: filename PEP8 standard, imports changed accordingly
+   
+======================================================================
+"""
+
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .gedcom5x import Gedcom5xRecord
+from .fact import Fact, FactType
+from .event import Event, EventType
+#=====================================================================
 
 fact_event_table = {
     # Person Fact / Event Types
@@ -178,33 +201,34 @@ fact_event_table = {
 }
 
 class GedcomXObject:
-    def __init__(self,record: Gedcom5xRecord | None = None) -> None:
-        self.created_with_tag: str = record.tag if record and isinstance(record, Gedcom5xRecord) else None    
-        self.created_at_level: int = record.level if record and isinstance(record, Gedcom5xRecord) else None
-        self.created_at_line_number: int = record.line_number if record and isinstance(record, Gedcom5xRecord) else None
+    def __init__(self,record: Gedcom5xRecord) -> None:
+        self.record = record
+        self.created_with_tag: str | None = record.tag if record and isinstance(record, Gedcom5xRecord) else None    
+        self.created_at_level: int | None = record.level if record and isinstance(record, Gedcom5xRecord) else None
+        self.created_at_line_number: int | None = record.line if record and isinstance(record, Gedcom5xRecord) else None
 
 class GedcomXSourceOrDocument(GedcomXObject):
-    def __init__(self,record: Gedcom5xRecord | None = None) -> None:
+    def __init__(self,record: Gedcom5xRecord) -> None:
         super().__init__(record)
-        self.title: str = None
-        self.citation: str = None
-        self.page: str = None
-        self.contributor: str = None
-        self.publisher: str = None
-        self.rights: str = None
-        self.url: str = None
-        self.medium: str = None
-        self.type: str = None
-        self.format: str = None
-        self.created: str = None
-        self.modified: str = None
-        self.language: str = None
-        self.relation: str = None
-        self.identifier: str = None
-        self.description: str = None
+        self.title: str | None = None
+        self.citation: str | None = None
+        self.page: str | None = None
+        self.contributor: str | None = None
+        self.publisher: str | None = None
+        self.rights: str | None = None
+        self.url: str | None = None
+        self.medium: str | None = None
+        self.type: str | None = None
+        self.format: str | None = None
+        self.created: str | None = None
+        self.modified: str | None = None
+        self.language: str | None = None
+        self.relation: str | None = None
+        self.identifier: str | None = None
+        self.description: str | None = None
 
 class GedcomXEventOrFact(GedcomXObject):
-    def __new__(cls,record: Gedcom5xRecord | None = None, object_stack: dict | None = None) -> object:
+    def __new__(cls,record: Gedcom5xRecord, object_stack: dict | None = None) -> object:
         super().__init__(record)
         if record.tag in fact_event_table.keys():
 

gedcomx/{Name.py → name.py}

@@ -1,6 +1,5 @@
 from enum import Enum
 from typing import List,Optional
-from typing_extensions import Self
 
 """
 ======================================================================
@@ -22,12 +21,13 @@ GEDCOM Module Types
 ======================================================================
 """
 #======================================================================
-from .Attribution import Attribution
-from .Conclusion import Conclusion, ConfidenceLevel
-from .Date import Date
-from .Note import Note
-from .Resource import Resource
-from .SourceReference import SourceReference
+from .attribution import Attribution
+from .conclusion import Conclusion, ConfidenceLevel
+from .date import Date
+from .document import Document
+from .note import Note
+from .resource import Resource
+from .source_reference import SourceReference
 #======================================================================
 
 
@@ -145,7 +145,7 @@ class NamePart:
     
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = {}
         if self.type:
             type_as_dict['type'] = self.type.value
@@ -226,7 +226,7 @@ class NameForm:
     
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = {}
         if self.lang:
             type_as_dict['lang'] = self.lang
@@ -309,7 +309,7 @@ class Name(Conclusion):
     def __init__(self, id: Optional[str] = None,
                  lang: Optional[str] = None,
                  sources: Optional[List[SourceReference]] = None,
-                 analysis: Resource = None,
+                 analysis: Optional[Document |Resource] = None,
                  notes: Optional[List[Note]] = None,
                  confidence: Optional[ConfidenceLevel] = None,
                  attribution: Optional[Attribution] = None,
@@ -321,16 +321,16 @@ class Name(Conclusion):
         self.nameForms = nameForms if nameForms else []
         self.date = date
     
-    def _add_name_part(self, namepart_to_add: NamePart):
-        if namepart_to_add and isinstance(namepart_to_add, NamePart):
+    def _add_name_part(self, namepart: NamePart):
+        if namepart and isinstance(namepart, NamePart):
             for current_namepart in self.nameForms[0].parts:
-                if namepart_to_add == current_namepart:
+                if namepart == current_namepart:
                     return False
-            self.nameForms[0].parts.append(namepart_to_add)
+            self.nameForms[0].parts.append(namepart)
     
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = super()._as_dict_
         if self.type:
             type_as_dict['type'] = getattr(self.type, 'value', self.type)

gedcomx/{Note.py → note.py}

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from .Attribution import Attribution
+from .attribution import Attribution
 
 class Note:
     identifier = 'http://gedcomx.org/v1/Note'
@@ -24,7 +24,7 @@ class Note:
     
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = {}
         if self.lang:
             type_as_dict["lang"] = self.lang

gedcomx/{OnlineAccount.py → online_account.py}

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from .Resource import Resource
+from .resource import Resource
 
 class OnlineAccount:
     identifier = 'http://gedcomx.org/v1/OnlineAccount'

gedcomx/{Person.py → person.py}

@@ -20,19 +20,19 @@ from urllib.parse import urljoin
 GEDCOM Module Types
 ======================================================================
 """
-from .Attribution import Attribution
-from .Conclusion import ConfidenceLevel
-from .Date import Date
-from .EvidenceReference import EvidenceReference
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .date import Date
+from .evidence_reference import EvidenceReference
 from .Extensions.rs10.rsLink import _rsLinkList
-from .Fact import Fact, FactType
-from .Gender import Gender, GenderType
-from .Identifier import IdentifierList
-from .Name import Name, QuickName
-from .Note import Note
-from .Resource import Resource
-from .SourceReference import SourceReference
-from .Subject import Subject
+from .fact import Fact, FactType
+from .gender import Gender, GenderType
+from .identifier import IdentifierList
+from .name import Name, QuickName
+from .note import Note
+from .resource import Resource
+from .source_reference import SourceReference
+from .subject import Subject
 
 class Person(Subject):
     """A person in the system.
@@ -93,6 +93,7 @@ class Person(Subject):
                     return False
             self.facts.append(fact_to_add)
             return True
+        return False
 
     def add_name(self, name_to_add: Name) -> bool:
         if len(self.names) > 5: 
@@ -105,9 +106,10 @@ class Person(Subject):
                     return False
             self.names.append(name_to_add)
             return True
+        return False
     
     def _add_relationship(self, relationship_to_add: object):
-        from .Relationship import Relationship
+        from .relationship import Relationship
         if isinstance(relationship_to_add,Relationship):
             self._relationships.append(relationship_to_add)
         else:
@@ -127,7 +129,7 @@ class Person(Subject):
 
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = super()._as_dict_  
         if self.private is not None:
             type_as_dict['private'] = self.private
@@ -149,12 +151,12 @@ class Person(Subject):
         """
         Create a Person instance from a JSON-dict (already parsed).
         """
-        from .Serialization import Serialization
+        from .serialization import Serialization
         return Serialization.deserialize(data, Person)
 
     @classmethod
     def from_familysearch(cls, pid: str, token: str, *, base_url: Optional[str] = None):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         """
         Fetch a single person by PID from FamilySearch and return a Person.
         - pid: e.g. "KPHP-4B4"

gedcomx/{PlaceDescription.py → place_description.py}

@@ -3,13 +3,13 @@ from typing import List, Optional
 """
 ======================================================================
  Project: Gedcom-X
- File:    PlaceDescription.py
+ File:    place_description.py
  Author:  David J. Cartwright
- Purpose: Python Object representation of GedcomX PlaceDescription Type
+ Purpose: 
 
  Created: 2025-08-25
  Updated:
-   - 2025-08-31: _as_dict_ to only create entries in dict for fields that hold data
+   - 2025-09-01: filename PEP8 standard
    
 ======================================================================
 """
@@ -19,17 +19,19 @@ from typing import List, Optional
 GEDCOM Module Types
 ======================================================================
 """
-from .Attribution import Attribution
-from .Conclusion import ConfidenceLevel
-from .Date import Date
-from .EvidenceReference import EvidenceReference
-from .Identifier import IdentifierList
-from .Note import Note
-from .Resource import Resource
-from .SourceReference import SourceReference
-from .Subject import Subject
-from .TextValue import TextValue
-from .URI import URI
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .date import Date
+from .evidence_reference import EvidenceReference
+from .identifier import IdentifierList
+from .note import Note
+from .resource import Resource
+from .source_reference import SourceReference
+from .subject import Subject
+from .textvalue import TextValue
+from .uri import URI
+#=====================================================================
+
 
 class PlaceDescription(Subject):
     """PlaceDescription describes the details of a place in terms of 
@@ -90,7 +92,7 @@ class PlaceDescription(Subject):
 
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = super()._as_dict_
         
         if self.names:
@@ -117,5 +119,5 @@ class PlaceDescription(Subject):
         """
         Create a PlaceDescription instance from a JSON-dict (already parsed).
         """
-        from .Serialization import Serialization
+        from .serialization import Serialization
         return Serialization.deserialize(data, PlaceDescription)   

gedcomx/{PlaceReference.py → place_reference.py}

@@ -1,7 +1,7 @@
 from __future__ import annotations
 from typing import Optional, TYPE_CHECKING
 if TYPE_CHECKING:
-    from .PlaceDescription import PlaceDescription
+    from .place_description import PlaceDescription
 
 """
 ======================================================================
@@ -22,7 +22,7 @@ if TYPE_CHECKING:
 GEDCOM Module Types
 ======================================================================
 """
-from .Resource import Resource
+from .resource import Resource
 
 class PlaceReference:
     """defines a reference to a PlaceDescription.
@@ -45,7 +45,7 @@ class PlaceReference:
 
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = {}
         if self.original:
             type_as_dict['original'] = self.original
@@ -55,7 +55,7 @@ class PlaceReference:
     
     @classmethod
     def _from_json_(cls, data):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         return Serialization.deserialize(data, PlaceReference)
 
 

gedcomx/{Qualifier.py → qualifier.py}

@@ -37,7 +37,7 @@ class Qualifier:
     
     @property
     def __as_dict__(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
 
         type_as_dict = {}
         if self.name:

gedcomx/{Relationship.py → relationship.py}

@@ -1,18 +1,36 @@
 from enum import Enum
 from typing import List, Optional
+"""
+======================================================================
+ Project: Gedcom-X
+ File:    relationship.py
+ Author:  David J. Cartwright
+ Purpose: 
 
-from .Attribution import Attribution
-from .Conclusion import ConfidenceLevel
-from .EvidenceReference import EvidenceReference
-from .Fact import Fact
-from .Identifier import Identifier
-from .Note import Note
-from .Person import Person
+ Created: 2025-08-25
+ Updated:
+   - 2025-09-31: filename PEP8 standard
+   
+======================================================================
+"""
 
-from .SourceReference import SourceReference
-from .Resource import Resource
+"""
+======================================================================
+GEDCOM Module Types
+======================================================================
+"""
+from .attribution import Attribution
+from .conclusion import ConfidenceLevel
+from .evidence_reference import EvidenceReference
+from .fact import Fact
+from .identifier import Identifier
+from .note import Note
+from .person import Person
+from .resource import Resource
+from .source_reference import SourceReference
+from .subject import Subject
+#=====================================================================
 
-from .Subject import Subject
 
 class RelationshipType(Enum):
     Couple = "http://gedcomx.org/Couple"
@@ -77,7 +95,7 @@ class Relationship(Subject):
 
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         type_as_dict = super()._as_dict_
         type_as_dict.update({
             "type": self.type.value if isinstance(self.type, RelationshipType) else self.type,
@@ -92,6 +110,6 @@ class Relationship(Subject):
         """
         Create a Person instance from a JSON-dict (already parsed).
         """
-        from .Serialization import Serialization
+        from .serialization import Serialization
         return Serialization.deserialize(data, Relationship)
     

gedcomx/{Resource.py → resource.py}

@@ -20,7 +20,7 @@ GEDCOM Module Types
 ======================================================================
 """
 
-from .URI import URI
+from .uri import URI
     
 class Resource:
     """
@@ -61,7 +61,7 @@ class Resource:
     
     @property
     def _as_dict_(self):
-        from .Serialization import Serialization
+        from .serialization import Serialization
         typ_as_dict = {}
         if self.resource:
             typ_as_dict['resource'] = self.resource.value if self.resource else None