diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1062858 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog + +## [0.1.0](https://github.com/ably/vcdiff-python/tree/v0.1.0) (2025-09-16) + +This is the initial release of the VCDIFF (RFC 3284) decoder library for Python. +It provides the following features: + +- Complete VCDIFF (RFC 3284) delta compression format decoder implementation +- Full delta parsing with structured output capabilities +- Adler32 checksum validation for data integrity +- Address cache implementation for COPY instruction optimization +- Comprehensive error handling with detailed error messages +- Command-line interface with apply, parse, and analyze commands +- Support for all VCDIFF instruction types (ADD, COPY, RUN) +- Compatible with Python 3.7+ +- 100% test coverage with 85/85 test cases passing +- Comprehensive test suite integration via vcdiff-tests submodule \ No newline at end of file diff --git a/README.md b/README.md index dce4d8a..c245fb4 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ The library provides a VCDIFF decoder that can decode delta files created accord ## Installation ```bash -pip install vcdiff +pip install vcdiff-decoder ``` ### Development Installation @@ -47,7 +47,7 @@ poetry install This repository includes the VCDIFF test suite as a git submodule. To clone the repository with all test cases: ```bash -git clone --recursive https://github.com/ably/vcdiff-py.git +git clone --recursive https://github.com/ably/vcdiff-python.git ``` If you've already cloned the repository without the submodule, initialize it: diff --git a/pyproject.toml b/pyproject.toml index 6cc2ae8..a6d8569 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "vcdiff-decoder" -version = "0.1.0a1" +version = "0.1.0" description = "Python implementation of VCDIFF (RFC 3284) delta compression format" readme = "README.md" license = "Apache-2.0" diff --git a/vcdiff_decoder/__init__.py b/vcdiff_decoder/__init__.py index 19b41be..17aaf3e 100644 --- a/vcdiff_decoder/__init__.py +++ b/vcdiff_decoder/__init__.py @@ -28,7 +28,7 @@ ) from .types import InstructionType -__version__ = "0.1.0a1" +__version__ = "0.1.0" __all__ = [ "Decoder", "decode",