No summary available
Project Links
Meta
Requires Python: >=3.11
Classifiers
Programming Language
- Python :: 3
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
- Python :: 3.15
- Python :: Implementation :: CPython
- Python :: Implementation :: PyPy
Typing
- Typed
cramjam
Install (Python)
pip install --upgrade cramjam # Requires no Python or system dependencies!
Pure-Rust backend
By default zstd, lz4, bzip2, xz and deflate/gzip/zlib use their C libraries.
To use libcramjam's pure-Rust
implementations instead (same API, no C), install the add-on and select it
before cramjam is imported:
pip install --upgrade "cramjam[pure-rust]"
export CRAMJAM_BACKEND=pure-rust # `cramjam.backend` reports which is active
Output is interchangeable between backends, but the compressed bytes may differ.
Development
Install the locked development dependencies, build the extension, and run the test suite:
make dev-setup
make test
Rust checks can be run separately with cargo test.
Install (JavaScript / TypeScript)
npm install cramjam
CLI
A CLI interface is available as cramjam-cli
libcramjam
A Rust crate and C friendly library available at libcramjam
Extremely thin and easy-to-install Python bindings to de/compression algorithms in Rust. Allows for using algorithms such as Snappy, without any system or other python dependencies.
Benchmarks
Some basic benchmarks are available in the benchmarks directory
Available algorithms:
- Snappy
cramjam.snappy - Brotli
cramjam.brotli - Bzip2
cramjam.bzip2 - Lz4
cramjam.lz4 - Gzip
cramjam.gzip - Zlib
cramjam.zlib - Deflate
cramjam.deflate - ZSTD
cramjam.zstd - XZ / LZMA
cramjam.xz
Experimental (Requires build from source enabling each feature):
- Blosc2
cramjam.experimental.blosc2 - ISA-L backend (only on 64-bit targets)
- igzip
cramjam.experimental.igzip - ideflate
cramjam.experimental.ideflate - izlib
cramjam.experimental.izlib
- igzip
All available for use as:
>>> import cramjam
>>> import numpy as np
>>> compressed = cramjam.snappy.compress(b"bytes here")
>>> decompressed = cramjam.snappy.decompress(compressed)
>>> decompressed
cramjam.Buffer(len=10) # an object which implements the buffer protocol
>>> bytes(decompressed)
b"bytes here"
>>> np.frombuffer(decompressed, dtype=np.uint8)
array([ 98, 121, 116, 101, 115, 32, 104, 101, 114, 101], dtype=uint8)
Where the API is cramjam.<compression-variant>.compress/decompress and accepts
bytes/bytearray/numpy.array/cramjam.File/cramjam.Buffer / memoryview objects.
de/compress_into
Additionally, all variants support decompress_into and compress_into.
Ex.
>>> import numpy as np
>>> from cramjam import snappy, Buffer
>>>
>>> data = np.frombuffer(b'some bytes here', dtype=np.uint8)
>>> data
array([115, 111, 109, 101, 32, 98, 121, 116, 101, 115, 32, 104, 101,
114, 101], dtype=uint8)
>>>
>>> compressed = Buffer()
>>> snappy.compress_into(data, compressed)
33 # 33 bytes written to compressed buffer
>>>
>>> compressed.tell() # Where is the buffer position?
33 # goodie!
>>>
>>> compressed.seek(0) # Go back to the start of the buffer so we can prepare to decompress
>>> decompressed = b'0' * len(data) # let's write to `bytes` as output
>>> decompressed
b'000000000000000'
>>>
>>> snappy.decompress_into(compressed, decompressed)
15 # 15 bytes written to decompressed
>>> decompressed
b'some bytes here'
import {Compress, Decompress} from 'cramjam';
const decoder = new TextDecoder();
const encoder = new TextEncoder();
const str = 'hello, world';
const encoded = encoder.encode(str);
const compressed = Compress.brotli(encoded);
const decompressed = Decompress.brotli(compressed);
const decoded = decoder.decode(decompressed);
2.14.0
Oct 13, 2026
2.13.0
Sep 29, 2026
2.12.1
Aug 25, 2026
2.12.0
Aug 22, 2026
2.12.0rc1
Apr 13, 2026
2.11.0
Jul 27, 2025
2.11.0rc4
Jul 27, 2025
2.11.0rc3
Jun 01, 2025
2.11.0rc2
Apr 25, 2025
2.11.0rc1
Apr 24, 2025
2.10.0
Apr 12, 2025
2.10.0rc1
Mar 01, 2025
2.9.1
Dec 12, 2024
2.9.0
Oct 16, 2024
2.9.0rc1
Oct 05, 2024
2.8.4
Sep 24, 2024
2.8.4rc4
Sep 24, 2024
2.8.4rc3
Sep 05, 2024
2.8.4rc2
May 03, 2024
2.8.4rc1
Apr 28, 2024
2.8.3
Mar 21, 2024
2.8.3rc1
Mar 09, 2024
2.8.2
Mar 02, 2024
2.8.1
Jan 26, 2024
2.8.1.dev1
Jan 22, 2024
2.8.0
Jan 15, 2024
2.7.0
Jul 29, 2023
2.7.0rc3
May 07, 2023
2.7.0rc2
Apr 29, 2023
2.7.0rc1
Apr 26, 2023
2.6.2
Nov 09, 2022
2.6.1
Oct 29, 2022
2.6.0
Oct 28, 2022
2.5.0
Nov 07, 2021
2.4.0
Sep 10, 2021
2.4.0rc2
Sep 08, 2021
2.4.0rc1
Sep 06, 2021
2.3.2
May 31, 2021
2.3.1
May 16, 2021
2.3.0
Apr 14, 2021
2.2.0
Mar 30, 2021
2.1.0
Mar 18, 2021
2.0.2
Feb 22, 2021
2.0.1
Feb 19, 2021
2.0.0
Feb 18, 2021
2.0.0rc2
Feb 18, 2021
2.0.0rc1
Feb 15, 2021
1.3.2
Jan 10, 2021
1.3.0
Jul 18, 2020
1.2.0
Jun 25, 2020
1.1.0
May 03, 2020
1.0.1
Mar 08, 2020
1.0.0
Mar 08, 2020
Wheel compatibility matrix
Files in release
cramjam-2.14.0-cp311-cp311-macosx_10_12_universal2.whl (3.3MiB)
cramjam-2.14.0-cp311-cp311-macosx_10_12_x86_64.whl (1.7MiB)
cramjam-2.14.0-cp311-cp311-macosx_11_0_arm64.whl (1.6MiB)
cramjam-2.14.0-cp311-cp311-manylinux_2_28_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp311-cp311-manylinux_2_28_i686.whl (1.9MiB)
cramjam-2.14.0-cp311-cp311-manylinux_2_28_ppc64le.whl (2.1MiB)
cramjam-2.14.0-cp311-cp311-manylinux_2_28_s390x.whl (2.3MiB)
cramjam-2.14.0-cp311-cp311-manylinux_2_28_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp311-cp311-manylinux_2_31_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp311-cp311-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl (2.0MiB)
cramjam-2.14.0-cp311-cp311-musllinux_1_2_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp311-cp311-musllinux_1_2_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp311-cp311-musllinux_1_2_i686.whl (2.0MiB)
cramjam-2.14.0-cp311-cp311-musllinux_1_2_x86_64.whl (2.0MiB)
cramjam-2.14.0-cp311-cp311-win32.whl (1.6MiB)
cramjam-2.14.0-cp311-cp311-win_amd64.whl (1.7MiB)
cramjam-2.14.0-cp311-cp311-win_arm64.whl (1.6MiB)
cramjam-2.14.0-cp312-cp312-macosx_10_13_universal2.whl (3.3MiB)
cramjam-2.14.0-cp312-cp312-macosx_10_13_x86_64.whl (1.7MiB)
cramjam-2.14.0-cp312-cp312-macosx_11_0_arm64.whl (1.6MiB)
cramjam-2.14.0-cp312-cp312-manylinux_2_28_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp312-cp312-manylinux_2_28_i686.whl (1.9MiB)
cramjam-2.14.0-cp312-cp312-manylinux_2_28_ppc64le.whl (2.1MiB)
cramjam-2.14.0-cp312-cp312-manylinux_2_28_s390x.whl (2.3MiB)
cramjam-2.14.0-cp312-cp312-manylinux_2_28_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp312-cp312-manylinux_2_31_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp312-cp312-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl (2.0MiB)
cramjam-2.14.0-cp312-cp312-musllinux_1_2_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp312-cp312-musllinux_1_2_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp312-cp312-musllinux_1_2_i686.whl (2.0MiB)
cramjam-2.14.0-cp312-cp312-musllinux_1_2_x86_64.whl (2.0MiB)
cramjam-2.14.0-cp312-cp312-win32.whl (1.6MiB)
cramjam-2.14.0-cp312-cp312-win_amd64.whl (1.7MiB)
cramjam-2.14.0-cp312-cp312-win_arm64.whl (1.6MiB)
cramjam-2.14.0-cp313-cp313-macosx_10_13_universal2.whl (3.3MiB)
cramjam-2.14.0-cp313-cp313-macosx_10_13_x86_64.whl (1.7MiB)
cramjam-2.14.0-cp313-cp313-macosx_11_0_arm64.whl (1.6MiB)
cramjam-2.14.0-cp313-cp313-manylinux_2_28_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp313-cp313-manylinux_2_28_i686.whl (1.9MiB)
cramjam-2.14.0-cp313-cp313-manylinux_2_28_ppc64le.whl (2.1MiB)
cramjam-2.14.0-cp313-cp313-manylinux_2_28_s390x.whl (2.3MiB)
cramjam-2.14.0-cp313-cp313-manylinux_2_28_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp313-cp313-manylinux_2_31_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp313-cp313-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl (2.0MiB)
cramjam-2.14.0-cp313-cp313-musllinux_1_2_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp313-cp313-musllinux_1_2_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp313-cp313-musllinux_1_2_i686.whl (2.0MiB)
cramjam-2.14.0-cp313-cp313-musllinux_1_2_x86_64.whl (2.0MiB)
cramjam-2.14.0-cp313-cp313-pyemscripten_2025_0_wasm32.whl (1.1MiB)
cramjam-2.14.0-cp313-cp313-win32.whl (1.6MiB)
cramjam-2.14.0-cp313-cp313-win_amd64.whl (1.7MiB)
cramjam-2.14.0-cp313-cp313-win_arm64.whl (1.6MiB)
cramjam-2.14.0-cp314-cp314-macosx_10_15_universal2.whl (3.3MiB)
cramjam-2.14.0-cp314-cp314-macosx_10_15_x86_64.whl (1.7MiB)
cramjam-2.14.0-cp314-cp314-macosx_11_0_arm64.whl (1.6MiB)
cramjam-2.14.0-cp314-cp314-manylinux_2_28_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp314-cp314-manylinux_2_28_i686.whl (1.9MiB)
cramjam-2.14.0-cp314-cp314-manylinux_2_28_ppc64le.whl (2.1MiB)
cramjam-2.14.0-cp314-cp314-manylinux_2_28_s390x.whl (2.3MiB)
cramjam-2.14.0-cp314-cp314-manylinux_2_28_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp314-cp314-manylinux_2_31_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp314-cp314-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl (2.0MiB)
cramjam-2.14.0-cp314-cp314-musllinux_1_2_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp314-cp314-musllinux_1_2_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp314-cp314-musllinux_1_2_i686.whl (2.0MiB)
cramjam-2.14.0-cp314-cp314-musllinux_1_2_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp314-cp314-pyemscripten_2026_0_wasm32.whl (1.1MiB)
cramjam-2.14.0-cp314-cp314-win32.whl (1.6MiB)
cramjam-2.14.0-cp314-cp314-win_amd64.whl (1.7MiB)
cramjam-2.14.0-cp314-cp314-win_arm64.whl (1.6MiB)
cramjam-2.14.0-cp314-cp314t-macosx_10_15_universal2.whl (3.3MiB)
cramjam-2.14.0-cp314-cp314t-macosx_10_15_x86_64.whl (1.7MiB)
cramjam-2.14.0-cp314-cp314t-macosx_11_0_arm64.whl (1.6MiB)
cramjam-2.14.0-cp314-cp314t-manylinux_2_28_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp314-cp314t-manylinux_2_28_i686.whl (1.9MiB)
cramjam-2.14.0-cp314-cp314t-manylinux_2_28_ppc64le.whl (2.1MiB)
cramjam-2.14.0-cp314-cp314t-manylinux_2_28_s390x.whl (2.3MiB)
cramjam-2.14.0-cp314-cp314t-manylinux_2_28_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp314-cp314t-manylinux_2_31_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp314-cp314t-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl (2.0MiB)
cramjam-2.14.0-cp314-cp314t-musllinux_1_2_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp314-cp314t-musllinux_1_2_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp314-cp314t-musllinux_1_2_i686.whl (2.0MiB)
cramjam-2.14.0-cp314-cp314t-musllinux_1_2_x86_64.whl (2.0MiB)
cramjam-2.14.0-cp314-cp314t-win32.whl (1.6MiB)
cramjam-2.14.0-cp314-cp314t-win_amd64.whl (1.7MiB)
cramjam-2.14.0-cp314-cp314t-win_arm64.whl (1.6MiB)
cramjam-2.14.0-cp315-cp315-macosx_10_15_universal2.whl (3.3MiB)
cramjam-2.14.0-cp315-cp315-macosx_10_15_x86_64.whl (1.7MiB)
cramjam-2.14.0-cp315-cp315-macosx_11_0_arm64.whl (1.6MiB)
cramjam-2.14.0-cp315-cp315-manylinux_2_28_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp315-cp315-manylinux_2_28_i686.whl (1.9MiB)
cramjam-2.14.0-cp315-cp315-manylinux_2_28_ppc64le.whl (2.1MiB)
cramjam-2.14.0-cp315-cp315-manylinux_2_28_s390x.whl (2.3MiB)
cramjam-2.14.0-cp315-cp315-manylinux_2_28_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp315-cp315-manylinux_2_31_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp315-cp315-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl (2.0MiB)
cramjam-2.14.0-cp315-cp315-musllinux_1_2_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp315-cp315-musllinux_1_2_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp315-cp315-musllinux_1_2_i686.whl (2.0MiB)
cramjam-2.14.0-cp315-cp315-musllinux_1_2_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp315-cp315-win32.whl (1.6MiB)
cramjam-2.14.0-cp315-cp315-win_amd64.whl (1.7MiB)
cramjam-2.14.0-cp315-cp315-win_arm64.whl (1.6MiB)
cramjam-2.14.0-cp315-cp315t-macosx_10_15_universal2.whl (3.3MiB)
cramjam-2.14.0-cp315-cp315t-macosx_10_15_x86_64.whl (1.7MiB)
cramjam-2.14.0-cp315-cp315t-macosx_11_0_arm64.whl (1.6MiB)
cramjam-2.14.0-cp315-cp315t-manylinux_2_28_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp315-cp315t-manylinux_2_28_i686.whl (1.9MiB)
cramjam-2.14.0-cp315-cp315t-manylinux_2_28_ppc64le.whl (2.1MiB)
cramjam-2.14.0-cp315-cp315t-manylinux_2_28_s390x.whl (2.3MiB)
cramjam-2.14.0-cp315-cp315t-manylinux_2_28_x86_64.whl (1.9MiB)
cramjam-2.14.0-cp315-cp315t-manylinux_2_31_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp315-cp315t-manylinux_2_34_riscv64.manylinux_2_39_riscv64.whl (2.0MiB)
cramjam-2.14.0-cp315-cp315t-musllinux_1_2_aarch64.whl (1.8MiB)
cramjam-2.14.0-cp315-cp315t-musllinux_1_2_armv7l.whl (1.7MiB)
cramjam-2.14.0-cp315-cp315t-musllinux_1_2_i686.whl (2.0MiB)
cramjam-2.14.0-cp315-cp315t-musllinux_1_2_x86_64.whl (2.0MiB)
cramjam-2.14.0-cp315-cp315t-win32.whl (1.6MiB)
cramjam-2.14.0-cp315-cp315t-win_amd64.whl (1.7MiB)
cramjam-2.14.0-cp315-cp315t-win_arm64.whl (1.6MiB)
cramjam-2.14.0-pp311-pypy311_pp73-macosx_10_15_x86_64.whl (1.8MiB)
cramjam-2.14.0-pp311-pypy311_pp73-macosx_11_0_arm64.whl (1.6MiB)
cramjam-2.14.0-pp311-pypy311_pp73-manylinux_2_28_aarch64.whl (1.8MiB)
cramjam-2.14.0-pp311-pypy311_pp73-manylinux_2_28_x86_64.whl (1.9MiB)
cramjam-2.14.0-pp311-pypy311_pp73-win_amd64.whl (1.7MiB)
cramjam-2.14.0.tar.gz (95.6KiB)
