xixu-me
4d3d34051f
Added 'sphinx.ext.coverage' to the Sphinx extensions in conf.py to enable coverage reporting. Removed 'README' and '404' entries from the documentation index in index.md for cleanup.
4.6 KiB
4.6 KiB
myst
| myst | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
tzst Documentation
Welcome to tzst, the next-generation Python library engineered for modern archive management, leveraging cutting-edge Zstandard compression to deliver superior performance, security, and reliability.
:maxdepth: 2
:caption: Contents:
quickstart
api/index
examples
What is tzst?
tzst is a modern Python library built exclusively for Python 3.12+ that provides comprehensive support for creating, extracting, and managing .tzst and .tar.zst archives. It combines the proven reliability of the tar format with the superior compression efficiency of Zstandard (zstd) to deliver:
- Superior Performance: Fast compression and decompression with excellent compression ratios
- Enterprise-Grade Security: Safe extraction with built-in protections against path traversal attacks
- Memory Efficiency: Streaming mode for handling large archives with minimal memory usage
- Cross-Platform Compatibility: Works seamlessly on Windows, macOS, and Linux
- Developer-Friendly: Clean, Pythonic API with comprehensive error handling
Key Features
🗜️ Advanced Compression
- Zstandard Compression: Best-in-class compression algorithm with configurable levels (1-22)
- Multiple Extensions: Support for both
.tzstand.tar.zstfile extensions - Streaming Support: Memory-efficient processing for large archives
🔒 Security First
- Safe by Default: Uses 'data' filter for secure extraction without dangerous path traversal
- Multiple Filter Options: Choose from 'data', 'tar', or 'fully_trusted' filters based on your security needs
- Atomic Operations: All file operations use temporary files with atomic moves to prevent corruption
💻 Dual Interfaces
- Command Line: Intuitive CLI with comprehensive options for batch operations
- Python API: Clean, object-oriented interface for programmatic use
- Convenience Functions: High-level functions for common operations
⚡ High Performance
- Optimized I/O: Efficient buffering and streaming for large files
- Conflict Resolution: Intelligent handling of file conflicts during extraction
- Cross-Platform: Native performance on all major operating systems
Quick Example
from tzst import TzstArchive, create_archive, extract_archive
# Create an archive
create_archive("backup.tzst", ["documents/", "photos/"], compression_level=5)
# Extract an archive
extract_archive("backup.tzst", "restore/")
# Work with archives programmatically
with TzstArchive("data.tzst", "r") as archive:
contents = archive.list(verbose=True)
archive.extract("important.txt", "output/")
is_valid = archive.test()
Installation
From PyPI
pip install tzst
From Source
git clone https://github.com/xixu-me/tzst.git
cd tzst
pip install .
Standalone Binaries
Download platform-specific standalone executables from GitHub Releases - no Python installation required!
Getting Started
For a quick introduction, see the {doc}quickstart guide. For comprehensive usage examples, explore the {doc}examples section.
Installation Options
- PyPI Installation (Recommended):
pip install tzst - Standalone Binaries: Download from GitHub Releases
- From Source: Clone and install from repository
API Documentation
Complete API documentation is available in the {doc}api/index section, covering:
- {doc}
api/core: Main classes and functions - {doc}
api/cli: Command-line interface - {doc}
api/exceptions: Error handling
Indices and tables
- :ref:
genindex - :ref:
modindex - :ref:
search
- {doc}
quickstart- Get up and running quickly with basic examples - {doc}
examples- Comprehensive usage examples and patterns - {doc}
api/index- Complete API reference documentation
Requirements
- Python 3.12 or higher
- zstandard >= 0.19.0
Reference Links
- {ref}
genindex - {ref}
modindex - {ref}
search