etlplus 0.12.10__py3-none-any.whl → 0.12.12__py3-none-any.whl

etlplus/file/ods.py

@@ -0,0 +1,79 @@
+"""
+:mod:`etlplus.file.ods` module.
+
+Helpers for reading/writing OpenDocument (ODS) spreadsheet files.
+
+Notes
+-----
+- An ODS file is a spreadsheet file created using the OpenDocument format.
+- Common cases:
+    - Spreadsheet files created by LibreOffice Calc, Apache OpenOffice Calc, or
+        other applications that support the OpenDocument format.
+    - Spreadsheet files exchanged in open standards environments.
+    - Spreadsheet files used in government or educational institutions
+        promoting open formats.
+- Rule of thumb:
+    - If the file follows the OpenDocument specification, use this module for
+        reading and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read ODS content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the ODS file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the ODS file.
+    """
+    return stub.read(path, format_name='ODS')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to ODS file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the ODS file on disk.
+    data : JSONData
+        Data to write as ODS file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the ODS file.
+    """
+    return stub.write(path, data, format_name='ODS')

etlplus/file/properties.py

@@ -1,12 +1,12 @@
 """
-:mod:`etlplus.file.props` module.
+:mod:`etlplus.file.properties` module.
 
-Helpers for reading/writing properties (PROPS) files.
+Helpers for reading/writing properties (PROPERTIES) files.
 
 Notes
 -----
-- A “PROPS-formatted” file is a properties file that typically uses
-    key-value pairs, often with a simple syntax.
+- A PROPERTIES file is a properties file that typically uses key-value pairs,
+    often with a simple syntax.
 - Common cases:
     - Java-style properties files with ``key=value`` pairs.
     - INI-style files without sections.
@@ -40,19 +40,19 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read PROPS content from ``path``.
+    Read PROPERTIES content from ``path``.
 
     Parameters
     ----------
     path : Path
-        Path to the PROPS file on disk.
+        Path to the PROPERTIES file on disk.
 
     Returns
     -------
     JSONList
-        The list of dictionaries read from the PROPS file.
+        The list of dictionaries read from the PROPERTIES file.
     """
-    return stub.read(path, format_name='PROPS')
+    return stub.read(path, format_name='PROPERTIES')
 
 
 def write(
@@ -60,19 +60,19 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to PROPS at ``path`` and return record count.
+    Write ``data`` to PROPERTIES at ``path`` and return record count.
 
     Parameters
     ----------
     path : Path
-        Path to the PROPS file on disk.
+        Path to the PROPERTIES file on disk.
     data : JSONData
-        Data to write as PROPS. Should be a list of dictionaries or a
+        Data to write as PROPERTIES. Should be a list of dictionaries or a
         single dictionary.
 
     Returns
     -------
     int
-        The number of rows written to the PROPS file.
+        The number of rows written to the PROPERTIES file.
     """
-    return stub.write(path, data, format_name='PROPS')
+    return stub.write(path, data, format_name='PROPERTIES')

etlplus/file/rda.py

@@ -0,0 +1,78 @@
+"""
+:mod:`etlplus.file.rda` module.
+
+Helpers for reading/writing RData workspace/object bundle (RDA) files.
+
+Notes
+-----
+- A RDA file is a binary file format used by R to store workspace objects,
+    including data frames, lists, and other R objects.
+- Common cases:
+    - Storing R data objects for later use.
+    - Sharing R datasets between users.
+    - Loading R data into Python for analysis.
+- Rule of thumb:
+    - If the file follows the RDA specification, use this module for reading
+        and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read RDA content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the RDA file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the RDA file.
+    """
+    return stub.read(path, format_name='RDA')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to RDA file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the RDA file on disk.
+    data : JSONData
+        Data to write as RDA file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the RDA file.
+    """
+    return stub.write(path, data, format_name='RDA')

etlplus/file/rds.py

@@ -0,0 +1,78 @@
+"""
+:mod:`etlplus.file.rds` module.
+
+Helpers for reading/writing R (RDS) data files.
+
+Notes
+-----
+- An RDS file is a binary file format used by R to store a single R object,
+    such as a data frame, list, or vector.
+- Common cases:
+    - Storing R objects for later use.
+    - Sharing R data between users.
+    - Loading R data into Python for analysis.
+- Rule of thumb:
+    - If the file follows the RDS specification, use this module for reading
+        and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read RDS content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the RDS file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the RDS file.
+    """
+    return stub.read(path, format_name='RDS')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to RDS file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the RDS file on disk.
+    data : JSONData
+        Data to write as RDS file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the RDS file.
+    """
+    return stub.write(path, data, format_name='RDS')

etlplus/file/sas7bdat.py

@@ -0,0 +1,78 @@
+"""
+:mod:`etlplus.file.sas7bdat` module.
+
+Helpers for reading/writing SAS (SAS7BDAT) data files.
+
+Notes
+-----
+- A SAS7BDAT file is a binary file format used by SAS to store datasets,
+    including variables, labels, and data types.
+- Common cases:
+    - Delimited text files (e.g., CSV, TSV).
+    - Fixed-width formatted files.
+    - Custom formats specific to certain applications.
+- Rule of thumb:
+    - If the file does not follow a specific standard format, use this module
+        for reading and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read DAT content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the SAS7BDAT file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the SAS7BDAT file.
+    """
+    return stub.read(path, format_name='SAS7BDAT')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to SAS7BDAT file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the SAS7BDAT file on disk.
+    data : JSONData
+        Data to write as SAS7BDAT file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the SAS7BDAT file.
+    """
+    return stub.write(path, data, format_name='SAS7BDAT')

etlplus/file/sav.py

@@ -0,0 +1,77 @@
+"""
+:mod:`etlplus.file.sav` module.
+
+Helpers for reading/writing SPSS (SAV) data files.
+
+Notes
+-----
+- A SAV file is a binary file format used by SPSS to store datasets, including
+    variables, labels, and data types.
+- Common cases:
+    - Reading data for analysis in Python.
+    - Writing processed data back to SPSS format.
+- Rule of thumb:
+    - If you need to work with SPSS data files, use this module for reading
+        and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read SAV content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the SAV file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the SAV file.
+    """
+    return stub.read(path, format_name='SAV')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to SAV file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the SAV file on disk.
+    data : JSONData
+        Data to write as SAV file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the SAV file.
+    """
+    return stub.write(path, data, format_name='SAV')

etlplus/file/sylk.py

@@ -0,0 +1,77 @@
+"""
+:mod:`etlplus.file.sylk` module.
+
+Helpers for reading/writing Symbolic Link (SYLK) data files.
+
+Notes
+-----
+- A SYLK file is a text-based file format used to represent spreadsheet
+    data, including cell values, formulas, and formatting.
+- Common cases:
+    - Storing spreadsheet data in a human-readable format.
+    - Exchanging data between different spreadsheet applications.
+- Rule of thumb:
+    - If you need to work with SYLK files, use this module for reading
+        and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read SYLK content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the SYLK file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the SYLK file.
+    """
+    return stub.read(path, format_name='SYLK')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to SYLK file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the SYLK file on disk.
+    data : JSONData
+        Data to write as SYLK file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the SYLK file.
+    """
+    return stub.write(path, data, format_name='SYLK')

etlplus/file/toml.py

@@ -5,7 +5,7 @@ Helpers for reading/writing Tom's Obvious Minimal Language (TOML) files.
 
 Notes
 -----
-- A “TOML-formatted” file is a configuration file that uses the TOML syntax.
+- A TOML file is a configuration file that uses the TOML syntax.
 - Common cases:
     - Simple key-value pairs.
     - Nested tables and arrays.

etlplus/file/vm.py

@@ -0,0 +1,78 @@
+"""
+:mod:`etlplus.file.vm` module.
+
+Helpers for reading/writing Apache Velocity (VM) template files.
+
+Notes
+-----
+- A VM file is a text file used for generating HTML or other text formats
+    by combining templates with data.
+- Common cases:
+    - HTML templates.
+    - Email templates.
+    - Configuration files.
+- Rule of thumb:
+    - If you need to work with Apache Velocity template files, use this module
+        for reading and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read VM content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the VM file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the VM file.
+    """
+    return stub.read(path, format_name='VM')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to VM file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the VM file on disk.
+    data : JSONData
+        Data to write as VM file. Should be a list of dictionaries or a single
+        dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the VM file.
+    """
+    return stub.write(path, data, format_name='VM')

etlplus/file/wks.py

@@ -0,0 +1,77 @@
+"""
+:mod:`etlplus.file.wks` module.
+
+Helpers for reading/writing Lotus 1-2-3 (WKS) spreadsheet files.
+
+Notes
+-----
+- A WKS file is a spreadsheet file created using the Lotus 1-2-3 format.
+- Common cases:
+    - Reading data from legacy Lotus 1-2-3 spreadsheets.
+    - Writing data to Lotus 1-2-3 format for compatibility.
+    - Converting WKS files to more modern formats.
+- Rule of thumb:
+    - If you need to work with Lotus 1-2-3 spreadsheet files, use this module
+        for reading and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read WKS content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the WKS file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the WKS file.
+    """
+    return stub.read(path, format_name='WKS')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to WKS file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the WKS file on disk.
+    data : JSONData
+        Data to write as WKS file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the WKS file.
+    """
+    return stub.write(path, data, format_name='WKS')