gedcomkit 0.1.8__cp39-abi3-win_amd64.whl

gedcomkit/__init__.py

@@ -0,0 +1,5 @@
+from .gedcomkit import *
+
+__doc__ = gedcomkit.__doc__
+if hasattr(gedcomkit, "__all__"):
+    __all__ = gedcomkit.__all__

gedcomkit/__init__.pyi

@@ -0,0 +1,90 @@
+"""Type stubs for gedcomkit, an archival-grade GEDCOM library.
+
+Views, findings and reports are plain dicts built from the core's JSON
+serialization; their keys are camelCase, as the Rust types name them.
+"""
+
+from os import PathLike
+from typing import Any, TypedDict
+
+from typing_extensions import NotRequired
+
+__version__: str
+
+class RecordSpec(TypedDict):
+    """A structure to add: only ``tag`` is required, and any other key is refused."""
+
+    tag: str
+    xref: NotRequired[str | None]
+    value: NotRequired[str | None]
+    children: NotRequired[list[RecordSpec]]
+
+class WrappedLine(TypedDict):
+    record: str
+    path: list[int]
+    tag: str
+
+class Gedcom:
+    @staticmethod
+    def parse(data: bytes) -> Gedcom:
+        """Read a document from a file's bytes; raises ValueError past the bounds."""
+    @staticmethod
+    def new_v551(source_system: str) -> Gedcom:
+        """An empty GEDCOM 5.5.1 document naming its producing system, declaring UTF-8."""
+    @staticmethod
+    def new_v7() -> Gedcom:
+        """An empty GEDCOM 7.0 document."""
+    @property
+    def encoding(self) -> str: ...
+    @property
+    def version(self) -> str | None: ...
+    @property
+    def content_records(self) -> int: ...
+    def records(self) -> list[dict[str, Any]]: ...
+    def record(self, xref: str) -> dict[str, Any]: ...
+    def individuals(self) -> list[dict[str, Any]]: ...
+    def families(self) -> list[dict[str, Any]]: ...
+    def validate(self) -> list[dict[str, Any]]: ...
+    def unresolved_pointers(self) -> list[dict[str, Any]]: ...
+    def parents_of(self, xref: str) -> list[str]: ...
+    def children_of(self, xref: str) -> list[str]: ...
+    def partners_of(self, xref: str) -> list[str]: ...
+    def append_records(self, records: list[RecordSpec]) -> None:
+        """Add records before the trailer, all or none; raises ValueError."""
+    def append_structures(
+        self, record: str, path: list[int], structures: list[RecordSpec]
+    ) -> None:
+        """Add substructures under ``path`` in ``record`` (an xref, or "HEAD")."""
+    def wrap_long_lines(self, max_line_bytes: int = 255) -> list[WrappedLine]:
+        """Split lines over the limit across CONC lines and name each one rewritten."""
+    def set_logical_value(self, xref: str, path: list[int], value: str) -> None: ...
+    def to_text(self) -> str: ...
+    def to_bytes(self) -> bytes: ...
+    def to_version7(
+        self, owned: list[tuple[str, str]] | None = None
+    ) -> tuple[Gedcom, list[dict[str, Any]]]:
+        """Convert to GEDCOM 7.0. ``owned`` declares the caller's own
+        extension tags as ``(tag, uri)`` pairs; any other extension is
+        declared as undocumented rather than dropped."""
+    def to_version551(self) -> tuple[Gedcom, list[dict[str, Any]]]: ...
+    def __len__(self) -> int: ...
+
+class ArchiveWriter:
+    @staticmethod
+    def new() -> ArchiveWriter: ...
+    def add(self, name: str, data: bytes) -> None: ...
+    def finish(self) -> bytes: ...
+
+class ArchiveFileWriter:
+    """A GEDZIP archive written straight to a file, one entry at a time."""
+
+    def __init__(self, path: str | PathLike[str]) -> None: ...
+    def add(self, name: str, data: bytes) -> None: ...
+    def add_file(self, name: str, source: str | PathLike[str]) -> None: ...
+    def finish(self) -> int:
+        """Close the archive and return its size in bytes."""
+
+def archive_total_size(data: bytes) -> int: ...
+def parse_date(text: str) -> dict[str, Any]:
+    """A date reading; its ``gedcom551`` and ``gedcom7`` keys are the 5.5.1
+    and 7.0 spellings, each ``None`` when that grammar cannot hold it."""

gedcomkit-0.1.8.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: gedcomkit
+Version: 0.1.8
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Sociology :: Genealogy
+License-File: LICENSE
+Summary: An archival-grade GEDCOM library: byte-preserving round-trip, encoding detection and reporting, GEDCOM 5.5 through 7.x, GEDZIP. Rust core, Python bindings.
+Keywords: gedcom,genealogy,parser,family-tree,gedzip
+License-Expression: AGPL-3.0-or-later
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# gedcomkit (Python)
+
+Python bindings for **gedcomkit**, an archival-grade GEDCOM library written
+in Rust: byte-preserving round-trip, encoding detection and reporting,
+GEDCOM 5.5 through 7.x. A node no caller touched is written back byte for
+byte; nothing is dropped for being unrecognized; hostile input is bounded.
+
+```python
+import gedcomkit
+
+doc = gedcomkit.Gedcom.parse(open("family.ged", "rb").read())
+print(doc.encoding)          # "Read as ANSEL, declared ANSEL"
+print(len(doc), doc.version)
+
+for person in doc.individuals():
+    print(person["names"], person["events"])
+
+for finding in doc.validate():
+    print(finding["severity"], finding["message"])
+
+# The family graph reads both directions of the link, so a one-sided
+# file (FAMC only, no CHIL) still answers.
+print(doc.parents_of("@I3@"))
+
+# Edit one structure by the path its view carries; every untouched
+# line still writes back byte for byte.
+doc.set_logical_value("@I1@", [0], "Ada /Lovelace/")
+open("family.ged", "wb").write(doc.to_bytes())
+```
+
+Build from this directory with [maturin](https://maturin.rs):
+
+```
+maturin develop          # into the active virtualenv
+maturin build --release  # a wheel
+```
+
+The Rust core lives at the root of the same repository; this crate
+is a thin PyO3 layer over its public API.
+
+License: AGPL-3.0-or-later, the same as the core (see LICENSE).
+

gedcomkit-0.1.8.dist-info/RECORD

@@ -0,0 +1,9 @@
+gedcomkit/__init__.py,sha256=Op9l5i81kqBAtE1sTZ8_nBRdvw8ibTDpmnpRh1Yu1o8,119
+gedcomkit/__init__.pyi,sha256=jUtos8GpM_dXGB-zEAlZC3O80Xssbo80XmuCMZss4Q0,3598
+gedcomkit/gedcomkit.pyd,sha256=XI-XBOEhPTUt84tgmNBLAnvTM_yfS7PrgQgfCCzZFug,931328
+gedcomkit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gedcomkit-0.1.8.dist-info/METADATA,sha256=dq_zSV5j5rjLXdLVJM5s8pAG_cU4LIT6fZk2TWb9q-E,1979
+gedcomkit-0.1.8.dist-info/WHEEL,sha256=_rgZdQc9sLFEqt2IemX7qyxsGt5fFRnBDATxGzerdmg,95
+gedcomkit-0.1.8.dist-info/licenses/LICENSE,sha256=DZak_2itbUtvHzD3E7GNUYSRK6jdOJ-GqncQ2weavLA,34523
+gedcomkit-0.1.8.dist-info/sboms/gedcomkit-py.cyclonedx.json,sha256=lALnpFvCY0st8X0kCC3gV3JVlZNkuz079X8hn2SgakI,33905
+gedcomkit-0.1.8.dist-info/RECORD,,

gedcomkit-0.1.8.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.14.1)
+Root-Is-Purelib: false
+Tag: cp39-abi3-win_amd64