datazip 0.2.0__tar.gz

datazip-0.2.0/.gitignore

@@ -0,0 +1,207 @@
+# Catalyst specific files
+*.swp
+commit.txt
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# MkDocs build output
+site/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+_version.py
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+coverage.info
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+tests/*.zip
+!tests/test_data/pudltabl.zip
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env_tox/
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+# as a library, we don't want to lock
+uv.lock
+pixi.lock
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# annoying mac stuff
+.DS_Store
+.DS_Store?
+~$*
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# PyCharm
+/.idea
+*.iml
+
+# ================= R related =================
+# History files
+.Rhistory
+.Rapp.history
+
+# Session Data files
+.RData
+.RDataTmp
+
+# User-specific files
+.Ruserdata
+
+# Example code in package build process
+*-Ex.R
+
+# Output files from R CMD build
+/*.tar.gz
+
+# Output files from R CMD check
+/*.Rcheck/
+
+# RStudio files
+.Rproj.user/
+#*.Rproj  # do want to share these files, for now
+
+# produced vignettes
+vignettes/*.html
+vignettes/*.pdf
+
+# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
+.httr-oauth
+
+# knitr and R markdown default cache directories
+*_cache/
+/cache/
+
+# Temporary files created by R markdown
+*.utf8.md
+*.knit.md
+
+# R Environment Variables
+.Renviron
+
+# translation temp files
+po/*~
+
+# RStudio Connect folder
+rsconnect/

datazip-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alex Engel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

datazip-0.2.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: datazip
+Version: 0.2.0
+Summary: Seamless serialization and deserialization of complex Python objects — a more flexible and readable alternative to pickle for data science workflows.
+Author-email: Alex Engel <alex@colectric.com>
+License: MIT License
+        
+        Copyright (c) 2026 Alex Engel
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Requires-Python: >=3.12
+Requires-Dist: orjson>=3.8
+Requires-Dist: tzdata>=2022.7; platform_system == 'Windows'
+Provides-Extra: dev
+Requires-Dist: coverage>=5.3; extra == 'dev'
+Requires-Dist: pandas>=2.0; extra == 'dev'
+Requires-Dist: plotly>5.10; extra == 'dev'
+Requires-Dist: polars>=0.20; extra == 'dev'
+Requires-Dist: pyarrow>=9; extra == 'dev'
+Requires-Dist: pytest>=6.2; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: matplotlib>=3.7; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.0; extra == 'docs'
+Requires-Dist: mkdocs>=1.5; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.24; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# DataZip
+[![Actions status]( https://github.com/colectric-dev/datazip/workflows/CI/badge.svg)](https://github.com/colectric-dev/datazip/actions)
+[![GitHub Pages Status]( https://github.com/colectric-dev/datazip/workflows/docs/badge.svg)](https://colectric-dev.github.io/datazip/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+
+
+**DataZip** is a Python library that extends [`zipfile.ZipFile`](https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile) to provide seamless serialization and deserialization of complex Python objects — a more flexible and readable alternative to pickle for data science workflows.
+
+## Why DataZip?
+
+- **Human-inspectable archives**: DataZip files are standard `.zip` files. You can open them with any archive tool and inspect the contents.
+- **Broad type support**: Works out of the box with pandas DataFrames/Series, NumPy arrays, Polars DataFrames, datetimes, paths, sets, frozensets, complex numbers, and custom classes.
+- **Efficient storage**: Tabular data is stored as Parquet; arrays as `.npy`. JSON is used for metadata and simple types.
+- **No pickle by default**: Most types are serialized without pickle, making files safer and more portable.
+- **Custom class integration**: Any class that implements `__getstate__`/`__setstate__` (the standard pickle protocol) works automatically. The `IOMixin` makes it even simpler.
+
+## Quick Example
+
+```python
+from io import BytesIO
+import pandas as pd
+from datazip import DataZip
+
+# Write
+buffer = BytesIO()
+with DataZip(buffer, "w") as z:
+    z["df"] = pd.DataFrame({"x": [1, 2, 3], "y": [4, 5, 6]})
+    z["config"] = {"threshold": 0.5, "labels": ["a", "b"]}
+    z["values"] = {1, 2, frozenset([3, 4])}
+
+# Read
+with DataZip(buffer, "r") as z:
+    df = z["df"]
+    config = z["config"]
+```
+
+## Supported Types
+
+| Category | Types                                                            |
+|---|------------------------------------------------------------------|
+| Primitives | `str`, `int`, `float`, `bool`, `None`, `complex`                 |
+| Collections | `dict`, `list`, `tuple`, `set`, `frozenset`, `deque`, `defaultdict` |
+| Date/Time | `datetime`, `pandas.Timestamp`                                   |
+| Paths | `pathlib.Path`                                                   |
+| NumPy | `numpy.ndarray`                                                  |
+| Pandas | `pandas.DataFrame`, `pandas.Series`                              |
+| Polars | `polars.DataFrame`, `polars.LazyFrame`, `polars.Series`          |
+| Custom | Any class with `__getstate__`/`__setstate__`                     |
+| Optional | Plotly figures                                 |
+
+
+See the [Installation](installation.md) page for full details including optional dependencies.

datazip-0.2.0/README.md

@@ -0,0 +1,53 @@
+# DataZip
+[![Actions status]( https://github.com/colectric-dev/datazip/workflows/CI/badge.svg)](https://github.com/colectric-dev/datazip/actions)
+[![GitHub Pages Status]( https://github.com/colectric-dev/datazip/workflows/docs/badge.svg)](https://colectric-dev.github.io/datazip/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+
+
+**DataZip** is a Python library that extends [`zipfile.ZipFile`](https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile) to provide seamless serialization and deserialization of complex Python objects — a more flexible and readable alternative to pickle for data science workflows.
+
+## Why DataZip?
+
+- **Human-inspectable archives**: DataZip files are standard `.zip` files. You can open them with any archive tool and inspect the contents.
+- **Broad type support**: Works out of the box with pandas DataFrames/Series, NumPy arrays, Polars DataFrames, datetimes, paths, sets, frozensets, complex numbers, and custom classes.
+- **Efficient storage**: Tabular data is stored as Parquet; arrays as `.npy`. JSON is used for metadata and simple types.
+- **No pickle by default**: Most types are serialized without pickle, making files safer and more portable.
+- **Custom class integration**: Any class that implements `__getstate__`/`__setstate__` (the standard pickle protocol) works automatically. The `IOMixin` makes it even simpler.
+
+## Quick Example
+
+```python
+from io import BytesIO
+import pandas as pd
+from datazip import DataZip
+
+# Write
+buffer = BytesIO()
+with DataZip(buffer, "w") as z:
+    z["df"] = pd.DataFrame({"x": [1, 2, 3], "y": [4, 5, 6]})
+    z["config"] = {"threshold": 0.5, "labels": ["a", "b"]}
+    z["values"] = {1, 2, frozenset([3, 4])}
+
+# Read
+with DataZip(buffer, "r") as z:
+    df = z["df"]
+    config = z["config"]
+```
+
+## Supported Types
+
+| Category | Types                                                            |
+|---|------------------------------------------------------------------|
+| Primitives | `str`, `int`, `float`, `bool`, `None`, `complex`                 |
+| Collections | `dict`, `list`, `tuple`, `set`, `frozenset`, `deque`, `defaultdict` |
+| Date/Time | `datetime`, `pandas.Timestamp`                                   |
+| Paths | `pathlib.Path`                                                   |
+| NumPy | `numpy.ndarray`                                                  |
+| Pandas | `pandas.DataFrame`, `pandas.Series`                              |
+| Polars | `polars.DataFrame`, `polars.LazyFrame`, `polars.Series`          |
+| Custom | Any class with `__getstate__`/`__setstate__`                     |
+| Optional | Plotly figures                                 |
+
+
+See the [Installation](installation.md) page for full details including optional dependencies.

datazip-0.2.0/pyproject.toml

@@ -0,0 +1,218 @@
+[build-system]
+requires = [ "hatchling", "hatch-vcs" ]
+build-backend = "hatchling.build"
+
+[project]
+name = "datazip"
+dynamic = [ "version" ]
+description = "Seamless serialization and deserialization of complex Python objects — a more flexible and readable alternative to pickle for data science workflows."
+readme = "README.md"
+authors = [
+    { name = "Alex Engel", email = "alex@colectric.com" }
+]
+license = { file = "LICENSE" }
+classifiers = [
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "orjson>=3.8",
+    "tzdata>=2022.7;platform_system=='Windows'",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pandas>=2.0",
+    "polars>=0.20",
+    "pyarrow>=9",
+    "coverage>=5.3",  # Lets us track what code is being tested
+    "pytest>=6.2",  # test framework
+    "plotly>5.10",
+]
+docs = [
+    "mkdocs>=1.5",
+    "mkdocs-material>=9.0",
+    "mkdocstrings[python]>=0.24",
+    "matplotlib>=3.7",
+]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build]
+hooks.vcs.version-file = "src/datazip/_version.py"
+targets.wheel.only-packages = true
+targets.sdist.only-packages = true
+targets.wheel.sources = ["src"]
+
+[tool.tox]
+env_list = [ "linters", "prep", "3.12", "3.13", "3.14", "coverage" ]
+
+[tool.tox.env.prep]
+skip_install = true
+deps = "coverage"
+commands = [ [ "coverage", "erase" ] ]
+
+[tool.tox.env_run_base]
+allowlist_externals = [ "bash", "ruff", "prek" ]
+runner = "uv-venv-runner"
+extras = [ "dev" ]
+commands = [
+    [ "coverage", "run", "--source={envsitepackagesdir}/datazip", "-m", "pytest", "--doctest-modules", "{envsitepackagesdir}/datazip", "tests/unit" ],
+]
+
+[tool.tox.env.coverage]
+depends = [ "3.12", "3.13", "3.14" ]
+skip_install = true
+deps = "coverage"
+commands = [
+    [ "coverage", "combine" ],
+    [ "coverage", "report", "--sort=cover" ],
+]
+
+[tool.tox.env.docs]
+description = "Build the MkDocs documentation."
+skip_install = false
+extras = [ "docs" ]
+allowlist_externals = [ "mkdocs" ]
+commands = [
+    [ "mkdocs", "build" ],
+]
+
+[tool.tox.env.linters]
+description = "Run the prek and ruff linters."
+commands = [
+    [ "prek", "run", "--all-files", "--show-diff-on-failure", "--skip", "ruff", "--skip", "ruff-format", "--skip", "prettier", "--skip", "doc8", "--skip", "rstcheck" ],
+    [ "ruff", "check", "." ],
+]
+
+[tool.coverage]
+run.parallel = true
+run.branch = true
+run.source = [ "datazip" ]
+paths.source = [ "src", ".tox/3*/**/site-packages" ]
+report.omit = [ "*/_version.py" ]
+report.show_missing = true
+
+[tool.pytest.ini_options]
+testpaths = [ "." ]
+addopts = [ "--verbose", "--doctest-modules" ]
+log_format = "%(asctime)s [%(levelname)8s] %(name)s:%(lineno)s %(message)s"
+log_date_format = " %Y-%m-%d %H:%M:%S"
+log_cli = true
+log_cli_level = "WARNING"
+doctest_optionflags = [ "NORMALIZE_WHITESPACE", "IGNORE_EXCEPTION_DETAIL", "ELLIPSIS" ]
+filterwarnings = [
+    "ignore:distutils Version classes are deprecated:DeprecationWarning",
+    "ignore:Creating a LegacyVersion:DeprecationWarning:pkg_resources[.*]",
+]
+
+[tool.ruff]
+line-length = 88
+show-fixes = true
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    ".pixi",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+[tool.ruff.format]
+# Enable reformatting of code snippets in docstrings.
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = [  # https://beta.ruff.rs/docs/rules/
+    "A", # flake8-builtins
+    "B", # flake8-bugbear
+    "C",
+    "C4", # flake8-comprehensions
+    "D", # flake8-docstrings
+    "E",  # pycodestyle
+    "F",  # Pyflakes
+    "FBT", # flake8-boolean-trap
+    "G", # flake8-logging-format
+    "I", # isort
+    "TID", # flake8-tidy-imports
+    "N", # pep8-naming
+    "PD",  # pandas
+    "PT", # flake8-pytest-style
+    "PGH", # pygrep-hooks
+    "S", # bandit
+    "SIM", # flake8-simplify
+    "TCH", # flake8-type-checking
+    "UP", # pyupgrade
+    "W",  # pycodestyle
+    "RUF", # Ruff-specific rules
+    "Q", # flake8-quotes
+]
+ignore = [
+    "D105",
+    "D203",  # 1 blank line required before class docstring
+    "D213",  # Multi-line docstring summary should start at the second line
+    "D401",  # First line of docstring should be in imperative mood: "{first_line}"
+    "D407",  # dashed-underline-after-section, upsets Sphinx
+    "D416",
+    # conflict with ruff format
+    "W191",  # tab-indentation
+    "E111",  # indentation-with-invalid-multiple
+    "E114",  # indentation-with-invalid-multiple-comment
+    "E117",  # over-indented
+    "D206",  # indent-with-spaces
+    "D300",  # triple-single-quotes
+    "Q000",  # bad-quotes-inline-string
+    "Q001",  # bad-quotes-multiline-string
+    "Q002",  # bad-quotes-docstring
+    "Q003",  # avoidable-escaped-quote
+    "COM812",  # missing-trailing-comma
+    "COM819",  # prohibited-trailing-comma
+    "ISC001",  # single-line-implicit-string-concatenation
+    "ISC002",  # multi-line-implicit-string-concatenation
+]
+flake8-tidy-imports.ban-relative-imports = "all"
+flake8-type-checking.strict = true
+mccabe.max-complexity = 15  # Unlike Flake8, default to a complexity level of 10.
+pycodestyle.max-doc-length = 88
+pydocstyle.convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = [ "F401" ]
+"docs/benchmarks.py" = [ "D103", "S301", "S311" ]
+"tests/*.py" = [
+    "D100",  # Missing docstring in public module
+    "D101",  # Missing docstring in public class
+    "F841",  # Local variable `pudl` is assigned to but never used
+    "FBT003", # Boolean positional value in function call, can't fix it pytest.param
+    "PD901",
+    "PT006",  # Wrong name(s) type in `@pytest.mark.parametrize`, expected `tuple`
+    "PT011",  # `pytest.raises(ValueError)` is too broad, set the `match` parameter or use a more specific exception
+    "S101",  # Use of `assert` detected
+    "SIM117",  # Use a single `with` statement with multiple contexts instead of nested `with` statements
+
+]
+"_test_classes.py" = [ "FBT003" ]

datazip-0.2.0/src/datazip/__init__.py

@@ -0,0 +1,17 @@
+"""Datazip."""
+
+import logging
+
+# Create a root logger for use anywhere within the package.
+logger = logging.getLogger("datazip")
+
+try:
+    from datazip._version import version as __version__
+except ImportError:
+    logger.warning("Version unknown because package is not installed.")
+    __version__ = "unknown"
+
+from datazip.core import DataZip  # noqa: E402
+from datazip.mixin import IOMixin  # noqa: E402
+
+__all__ = ["DataZip", "IOMixin", "__version__"]