splitzip 0.1.0__tar.gz

splitzip-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+venv/
+.venv/
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/

splitzip-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jimothy
+
+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.

splitzip-0.1.0/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: splitzip
+Version: 0.1.0
+Summary: Create split ZIP archives compatible with standard tools
+Project-URL: Homepage, https://github.com/twwat/splitzip
+Project-URL: Repository, https://github.com/twwat/splitzip
+Project-URL: Issues, https://github.com/twwat/splitzip/issues
+Author-email: twwat <mailto.yourusername@wwwcomdot.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: 7z,archive,compression,multipart,split,zip
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Archiving :: Compression
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+[![PyPI version](https://badge.fury.io/py/splitzip.svg)](https://pypi.org/project/splitzip/) [![Python versions](https://img.shields.io/pypi/pyversions/splitzip)](https://pypi.org/project/splitzip/) [![License: MIT](https://img.shields.io/pypi/l/splitzip)](https://opensource.org/licenses/MIT)
+
+# splitzip
+
+Create split ZIP archives compatible with standard tools.
+
+**No 7-Zip required.** Archives created with splitzip can be extracted using Windows Explorer, WinZip, macOS Archive Utility, and standard `unzip` on Linux.
+
+## Features
+
+- Pure Python, no external dependencies
+- Compatible with standard ZIP tools (no proprietary formats)
+- Human-friendly size specifications (`"100MB"`, `"700MiB"`, `"4.7GB"`)
+- Progress callbacks for large files
+- Context manager support
+- CLI tool included
+
+## Installation
+
+```bash
+pip install splitzip
+```
+
+## Quick Start
+
+### Simple Usage
+
+```python
+import splitzip
+
+# Create a split archive from files
+splitzip.create(
+    "backup.zip",
+    ["documents/", "photos/", "important.pdf"],
+    split_size="650MB"
+)
+```
+
+Output files: `backup.z01`, `backup.z02`, ..., `backup.zip`
+
+### Context Manager
+
+```python
+from splitzip import SplitZipWriter
+
+with SplitZipWriter("backup.zip", split_size="100MB") as zf:
+    # Add files
+    zf.write("document.pdf")
+    zf.write("photos/", recursive=True)
+    
+    # Add with custom name
+    zf.write("secret.txt", arcname="data/renamed.txt")
+    
+    # Add content directly
+    zf.writestr("hello.txt", b"Hello, World!")
+    zf.writestr("config.json", '{"key": "value"}')
+```
+
+### Advanced Options
+
+```python
+from splitzip import SplitZipWriter, STORED, DEFLATED
+
+def on_progress(filename, bytes_done, total_bytes):
+    pct = (bytes_done / total_bytes) * 100
+    print(f"\r{filename}: {pct:.1f}%", end="")
+
+def on_volume(volume_num, path):
+    print(f"Created volume: {path}")
+
+with SplitZipWriter(
+    "backup.zip",
+    split_size="700MiB",          # DVD size
+    compression=DEFLATED,          # or STORED for no compression
+    compresslevel=9,               # 1-9 (default: 6)
+    on_volume=on_volume,           # Volume creation callback
+    on_progress=on_progress,       # Progress callback
+) as zf:
+    zf.write("large_file.bin")
+```
+
+### Streaming from File Objects
+
+```python
+import io
+from splitzip import SplitZipWriter
+
+data = get_data_from_somewhere()
+
+with SplitZipWriter("archive.zip", split_size="100MB") as zf:
+    zf.write_fileobj(
+        io.BytesIO(data),
+        arcname="streamed.bin",
+        size=len(data)  # Optional, enables progress callback
+    )
+```
+
+## Size Specifications
+
+splitzip accepts sizes in multiple formats:
+
+| Format | Example | Bytes |
+|--------|---------|-------|
+| Integer | `104857600` | 104,857,600 |
+| Bytes | `"100B"` | 100 |
+| Kilobytes (decimal) | `"100KB"` | 100,000 |
+| Megabytes (decimal) | `"100MB"` | 100,000,000 |
+| Gigabytes (decimal) | `"4.7GB"` | 4,700,000,000 |
+| Kibibytes (binary) | `"100KiB"` | 102,400 |
+| Mebibytes (binary) | `"700MiB"` | 734,003,200 |
+| Gibibytes (binary) | `"1GiB"` | 1,073,741,824 |
+
+Common split sizes:
+- CD-ROM: `"650MB"` or `"700MB"`
+- DVD: `"4.7GB"`
+- FAT32 limit: `"4GiB"` (minus 1 byte)
+- Email attachment: `"25MB"`
+
+## Command Line Interface
+
+```bash
+# Create a split archive
+splitzip create -o backup.zip -s 100MB file1.txt directory/
+
+# With options
+splitzip create -o backup.zip -s 700MiB \
+    --level 9 \           # Max compression
+    --verbose \           # Show progress
+    documents/ photos/
+
+# Store without compression
+splitzip create -o backup.zip -s 100MB --store largefile.bin
+```
+
+## Output File Naming
+
+splitzip follows the standard ZIP split archive convention:
+
+```
+backup.z01  (first volume)
+backup.z02  (second volume)
+backup.z03  (third volume)
+...
+backup.zip  (final volume, contains central directory)
+```
+
+**All files must be present in the same directory for extraction.**
+
+## Compatibility
+
+| Tool | Single Volume | Split Archive |
+|------|:-------------:|:-------------:|
+| Windows Explorer | ✅ | ✅ |
+| WinZip | ✅ | ✅ |
+| 7-Zip | ✅ | ✅ |
+| macOS Archive Utility | ✅ | ✅* |
+| Linux `unzip` | ✅ | ✅** |
+| Python `zipfile` | ✅ | ❌ |
+
+\* May require all files to be selected and opened together  
+\*\* May require `unzip -F` flag for split archives
+
+## Limitations
+
+- **No ZIP64 support yet**: Individual files must be under 4GB, total entries under 65,535
+- **No encryption**: Use filesystem encryption for sensitive data
+- **No reading/extraction**: This is a write-only library (use standard tools to extract)
+- **No ZSTD/LZMA**: Only DEFLATE and STORED compression (for compatibility)
+
+## Development
+
+```bash
+# Clone and install in development mode
+git clone https://github.com/jimothy/splitzip
+cd splitzip
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run with coverage
+pytest --cov=splitzip
+
+# Type checking
+mypy src/splitzip
+
+# Linting
+ruff check src/splitzip
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions welcome! Please open an issue to discuss major changes before submitting a PR.

splitzip-0.1.0/README.md

@@ -0,0 +1,197 @@
+[![PyPI version](https://badge.fury.io/py/splitzip.svg)](https://pypi.org/project/splitzip/) [![Python versions](https://img.shields.io/pypi/pyversions/splitzip)](https://pypi.org/project/splitzip/) [![License: MIT](https://img.shields.io/pypi/l/splitzip)](https://opensource.org/licenses/MIT)
+
+# splitzip
+
+Create split ZIP archives compatible with standard tools.
+
+**No 7-Zip required.** Archives created with splitzip can be extracted using Windows Explorer, WinZip, macOS Archive Utility, and standard `unzip` on Linux.
+
+## Features
+
+- Pure Python, no external dependencies
+- Compatible with standard ZIP tools (no proprietary formats)
+- Human-friendly size specifications (`"100MB"`, `"700MiB"`, `"4.7GB"`)
+- Progress callbacks for large files
+- Context manager support
+- CLI tool included
+
+## Installation
+
+```bash
+pip install splitzip
+```
+
+## Quick Start
+
+### Simple Usage
+
+```python
+import splitzip
+
+# Create a split archive from files
+splitzip.create(
+    "backup.zip",
+    ["documents/", "photos/", "important.pdf"],
+    split_size="650MB"
+)
+```
+
+Output files: `backup.z01`, `backup.z02`, ..., `backup.zip`
+
+### Context Manager
+
+```python
+from splitzip import SplitZipWriter
+
+with SplitZipWriter("backup.zip", split_size="100MB") as zf:
+    # Add files
+    zf.write("document.pdf")
+    zf.write("photos/", recursive=True)
+    
+    # Add with custom name
+    zf.write("secret.txt", arcname="data/renamed.txt")
+    
+    # Add content directly
+    zf.writestr("hello.txt", b"Hello, World!")
+    zf.writestr("config.json", '{"key": "value"}')
+```
+
+### Advanced Options
+
+```python
+from splitzip import SplitZipWriter, STORED, DEFLATED
+
+def on_progress(filename, bytes_done, total_bytes):
+    pct = (bytes_done / total_bytes) * 100
+    print(f"\r{filename}: {pct:.1f}%", end="")
+
+def on_volume(volume_num, path):
+    print(f"Created volume: {path}")
+
+with SplitZipWriter(
+    "backup.zip",
+    split_size="700MiB",          # DVD size
+    compression=DEFLATED,          # or STORED for no compression
+    compresslevel=9,               # 1-9 (default: 6)
+    on_volume=on_volume,           # Volume creation callback
+    on_progress=on_progress,       # Progress callback
+) as zf:
+    zf.write("large_file.bin")
+```
+
+### Streaming from File Objects
+
+```python
+import io
+from splitzip import SplitZipWriter
+
+data = get_data_from_somewhere()
+
+with SplitZipWriter("archive.zip", split_size="100MB") as zf:
+    zf.write_fileobj(
+        io.BytesIO(data),
+        arcname="streamed.bin",
+        size=len(data)  # Optional, enables progress callback
+    )
+```
+
+## Size Specifications
+
+splitzip accepts sizes in multiple formats:
+
+| Format | Example | Bytes |
+|--------|---------|-------|
+| Integer | `104857600` | 104,857,600 |
+| Bytes | `"100B"` | 100 |
+| Kilobytes (decimal) | `"100KB"` | 100,000 |
+| Megabytes (decimal) | `"100MB"` | 100,000,000 |
+| Gigabytes (decimal) | `"4.7GB"` | 4,700,000,000 |
+| Kibibytes (binary) | `"100KiB"` | 102,400 |
+| Mebibytes (binary) | `"700MiB"` | 734,003,200 |
+| Gibibytes (binary) | `"1GiB"` | 1,073,741,824 |
+
+Common split sizes:
+- CD-ROM: `"650MB"` or `"700MB"`
+- DVD: `"4.7GB"`
+- FAT32 limit: `"4GiB"` (minus 1 byte)
+- Email attachment: `"25MB"`
+
+## Command Line Interface
+
+```bash
+# Create a split archive
+splitzip create -o backup.zip -s 100MB file1.txt directory/
+
+# With options
+splitzip create -o backup.zip -s 700MiB \
+    --level 9 \           # Max compression
+    --verbose \           # Show progress
+    documents/ photos/
+
+# Store without compression
+splitzip create -o backup.zip -s 100MB --store largefile.bin
+```
+
+## Output File Naming
+
+splitzip follows the standard ZIP split archive convention:
+
+```
+backup.z01  (first volume)
+backup.z02  (second volume)
+backup.z03  (third volume)
+...
+backup.zip  (final volume, contains central directory)
+```
+
+**All files must be present in the same directory for extraction.**
+
+## Compatibility
+
+| Tool | Single Volume | Split Archive |
+|------|:-------------:|:-------------:|
+| Windows Explorer | ✅ | ✅ |
+| WinZip | ✅ | ✅ |
+| 7-Zip | ✅ | ✅ |
+| macOS Archive Utility | ✅ | ✅* |
+| Linux `unzip` | ✅ | ✅** |
+| Python `zipfile` | ✅ | ❌ |
+
+\* May require all files to be selected and opened together  
+\*\* May require `unzip -F` flag for split archives
+
+## Limitations
+
+- **No ZIP64 support yet**: Individual files must be under 4GB, total entries under 65,535
+- **No encryption**: Use filesystem encryption for sensitive data
+- **No reading/extraction**: This is a write-only library (use standard tools to extract)
+- **No ZSTD/LZMA**: Only DEFLATE and STORED compression (for compatibility)
+
+## Development
+
+```bash
+# Clone and install in development mode
+git clone https://github.com/jimothy/splitzip
+cd splitzip
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run with coverage
+pytest --cov=splitzip
+
+# Type checking
+mypy src/splitzip
+
+# Linting
+ruff check src/splitzip
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions welcome! Please open an issue to discuss major changes before submitting a PR.

splitzip-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "splitzip"
+version = "0.1.0"
+description = "Create split ZIP archives compatible with standard tools"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    { name = "twwat", email = "mailto.yourusername@wwwcomdot.com" }
+]
+keywords = ["zip", "archive", "split", "multipart", "compression", "7z"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: System :: Archiving :: Compression",
+]
+
+[project.urls]
+Homepage = "https://github.com/twwat/splitzip"
+Repository = "https://github.com/twwat/splitzip"
+Issues = "https://github.com/twwat/splitzip/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0",
+]
+
+[project.scripts]
+splitzip = "splitzip.__main__:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/splitzip"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM"]
+
+[tool.mypy]
+python_version = "3.9"
+strict = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"

splitzip-0.1.0/src/splitzip/__init__.py

@@ -0,0 +1,107 @@
+"""
+splitzip - Create split ZIP archives compatible with standard tools.
+
+Create multi-part ZIP archives that can be extracted with Windows Explorer,
+WinZip, 7-Zip, and other standard tools without requiring special software.
+
+Example:
+    >>> import splitzip
+    >>> 
+    >>> # Simple one-liner
+    >>> splitzip.create("backup.zip", ["file1.txt", "data/"], split_size="100MB")
+    >>> 
+    >>> # Context manager for more control
+    >>> with splitzip.SplitZipWriter("backup.zip", split_size="100MB") as zf:
+    ...     zf.write("file1.txt")
+    ...     zf.write("data/", recursive=True)
+    ...     zf.writestr("hello.txt", b"Hello, world!")
+
+The resulting files will be named:
+    backup.z01, backup.z02, ..., backup.zip
+
+The final .zip file contains the central directory and must be present
+along with all .zXX files for extraction.
+"""
+
+from .exceptions import (
+    CompressionError,
+    FileNotFoundInArchiveError,
+    IntegrityError,
+    SplitZipError,
+    VolumeTooSmallError,
+    VolumeError,
+)
+from .structures import Compression
+from .utils import format_size, parse_size
+from .writer import SplitZipWriter
+
+__version__ = "0.1.0"
+__all__ = [
+    # Main classes
+    "SplitZipWriter",
+    # Convenience functions
+    "create",
+    # Constants
+    "Compression",
+    "STORED",
+    "DEFLATED",
+    # Utilities
+    "parse_size",
+    "format_size",
+    # Exceptions
+    "SplitZipError",
+    "VolumeError",
+    "VolumeTooSmallError",
+    "CompressionError",
+    "IntegrityError",
+    "FileNotFoundInArchiveError",
+]
+
+# Convenience aliases
+STORED = Compression.STORED
+DEFLATED = Compression.DEFLATED
+
+
+def create(
+    path: str,
+    files: list[str],
+    split_size: int | str,
+    compression: int = DEFLATED,
+    compresslevel: int = 6,
+    recursive: bool = True,
+) -> list[str]:
+    """
+    Create a split ZIP archive from a list of files/directories.
+
+    This is a convenience function for simple use cases. For more control,
+    use SplitZipWriter directly.
+
+    Args:
+        path: Path for the final .zip file.
+        files: List of file/directory paths to include.
+        split_size: Maximum size per volume (e.g., "100MB", "700MiB", 104857600).
+        compression: Compression method (STORED or DEFLATED).
+        compresslevel: DEFLATE compression level 1-9 (default 6).
+        recursive: If True, add directory contents recursively.
+
+    Returns:
+        List of paths to all volume files created.
+
+    Example:
+        >>> splitzip.create(
+        ...     "backup.zip",
+        ...     ["documents/", "photos/", "important.pdf"],
+        ...     split_size="650MB"  # CD-ROM size
+        ... )
+        ['backup.z01', 'backup.z02', 'backup.zip']
+    """
+    with SplitZipWriter(
+        path,
+        split_size=split_size,
+        compression=compression,
+        compresslevel=compresslevel,
+    ) as zf:
+        for file_path in files:
+            zf.write(file_path, recursive=recursive)
+
+    return [str(p) for p in zf.volume_paths]