File: index.md

package info (click to toggle)
python-pyzstd 0.19.1-1~exp1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 496 kB
  • sloc: python: 5,754; makefile: 4
file content (28 lines) | stat: -rw-r--r-- 1,526 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
```{toctree}
:hidden:
:maxdepth: 2

Home <self>
Migration to stdlib <stdlib.md>
Module reference <pyzstd>
Deprecations <deprecated.md>
```

# pyzstd

The `pyzstd` library was created by Ma Lin in 2020 to provide Python support for [Zstandard](http://www.zstd.net), using an API style similar to the `bz2`, `lzma`, and `zlib` modules.

In 2025, an effort led by [Emma Smith](https://github.com/emmatyping) (now a CPython core developer) resulted in [PEP 784][] and the inclusion of the [`compression.zstd` module][compression.zstd] in the Python 3.14 standard library. The implementation was adapted from `pyzstd`, with its maintainer [Rogdham](https://github.com/rogdham) contributing directly to the effort. Rogdham also developed the [`backports.zstd` library][backports.zstd] which backports the `compression.zstd` APIs to older Python versions.

In version 0.19.0, `pyzstd` became a pure-Python package by using the `compression.zstd` module internally.

Recommendations:

- **New projects**: use the standard library [`compression.zstd` module][compression.zstd], with [`backports.zstd`][backports.zstd] as a fallback for older Python versions.
- **Existing projects**: consider [migrating to the standard library implementation](./stdlib.md).

In the meanwhile, [documentation for the `pyzstd` module is available here](./pyzstd.rst).

[PEP 784]: https://peps.python.org/pep-0784/
[compression.zstd]: https://docs.python.org/3.14/library/compression.zstd.html
[backports.zstd]: https://github.com/Rogdham/backports.zstd