# `compress_pickle`
### Standard python pickle, thinly wrapped with standard compression libraries
[](https://github.com/ambv/black)
[](https://dev.azure.com/lucianopazneuro/lucianopazneuro/_build/latest?definitionId=1&branchName=master)
[](https://codecov.io/gh/lucianopaz/compress_pickle)
[](https://pypi.org/project/compress-pickle/)
[](https://opensource.org/licenses/MIT)
The standard [pickle package](https://docs.python.org/3/library/pickle.html) provides an excellent default tool for serializing arbitrary python objects and storing them to disk. Standard python also includes broad set of [data compression packages](https://docs.python.org/3/library/archiving.html). `compress_pickle` provides an interface to the standard `pickle.dump`, `pickle.load`, `pickle.dumps` and `pickle.loads` functions, but wraps them in order to direct the serialized data through one of the standard compression packages. This way you can seemlessly serialize data to disk or to any file-like object in a compressed way.
`compress_pickle` supports python >= 3.6. If you must support python 3.5, install `compress_pickle==v1.1.1`.
Supported compression protocols:
- [gzip](https://docs.python.org/3/library/gzip.html)
- [bz2](https://docs.python.org/3/library/bz2.html)
- [lzma](https://docs.python.org/3/library/lzma.html)
- [zipfile](https://docs.python.org/3/library/zipfile.html)
Furthermore, `compress_pickle` supports the [`lz4`](https://pypi.org/project/lz4/) compression protocol, that isn't part of the standard python compression packages. This is provided as an optional extra requirement that can be installed as:
```bash
pip install compress_pickle[lz4]
```
Please refer to the [package's documentation](https://lucianopaz.github.io/compress_pickle/html) for more information
Raw data
{
"_id": null,
"home_page": "https://github.com/lucianopaz/compress_pickle",
"name": "compress-pickle",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Luciano Paz",
"author_email": "luciano.paz.neuro@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c8/23/a448abd4e98b64ad5b99537a2b4df3f6a829e6fac749afbaf921f89c0941/compress_pickle-2.1.0.tar.gz",
"platform": "",
"description": "# `compress_pickle`\n### Standard python pickle, thinly wrapped with standard compression libraries\n\n[](https://github.com/ambv/black)\n[](https://dev.azure.com/lucianopazneuro/lucianopazneuro/_build/latest?definitionId=1&branchName=master)\n[](https://codecov.io/gh/lucianopaz/compress_pickle)\n[](https://pypi.org/project/compress-pickle/)\n[](https://opensource.org/licenses/MIT)\n\nThe standard [pickle package](https://docs.python.org/3/library/pickle.html) provides an excellent default tool for serializing arbitrary python objects and storing them to disk. Standard python also includes broad set of [data compression packages](https://docs.python.org/3/library/archiving.html). `compress_pickle` provides an interface to the standard `pickle.dump`, `pickle.load`, `pickle.dumps` and `pickle.loads` functions, but wraps them in order to direct the serialized data through one of the standard compression packages. This way you can seemlessly serialize data to disk or to any file-like object in a compressed way.\n\n`compress_pickle` supports python >= 3.6. If you must support python 3.5, install `compress_pickle==v1.1.1`.\n\nSupported compression protocols:\n- [gzip](https://docs.python.org/3/library/gzip.html)\n- [bz2](https://docs.python.org/3/library/bz2.html)\n- [lzma](https://docs.python.org/3/library/lzma.html)\n- [zipfile](https://docs.python.org/3/library/zipfile.html)\n\nFurthermore, `compress_pickle` supports the [`lz4`](https://pypi.org/project/lz4/) compression protocol, that isn't part of the standard python compression packages. This is provided as an optional extra requirement that can be installed as:\n\n```bash\npip install compress_pickle[lz4]\n```\n\nPlease refer to the [package's documentation](https://lucianopaz.github.io/compress_pickle/html) for more information\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Standard pickle, wrapped with standard compression libraries",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/lucianopaz/compress_pickle"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f34ff94ac1b84d2169cf2ebf64353ce98fd743f85d30678059c514d9b3d6644c",
"md5": "0354e99efe20861fa6804cb7ee17880d",
"sha256": "598650da4686d9bd97bee185b61e74d7fe1872bb0c23909d5ed2d8793b4a8818"
},
"downloads": -1,
"filename": "compress_pickle-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0354e99efe20861fa6804cb7ee17880d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 24694,
"upload_time": "2021-09-21T18:13:57",
"upload_time_iso_8601": "2021-09-21T18:13:57.047845Z",
"url": "https://files.pythonhosted.org/packages/f3/4f/f94ac1b84d2169cf2ebf64353ce98fd743f85d30678059c514d9b3d6644c/compress_pickle-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c823a448abd4e98b64ad5b99537a2b4df3f6a829e6fac749afbaf921f89c0941",
"md5": "2e8af32bce3a6623a0df18038ab07c28",
"sha256": "3e944ce0eeab5b6331324d62351c957d41c9327c8417d439843e88fe69b77991"
},
"downloads": -1,
"filename": "compress_pickle-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2e8af32bce3a6623a0df18038ab07c28",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16360,
"upload_time": "2021-09-21T18:13:58",
"upload_time_iso_8601": "2021-09-21T18:13:58.570781Z",
"url": "https://files.pythonhosted.org/packages/c8/23/a448abd4e98b64ad5b99537a2b4df3f6a829e6fac749afbaf921f89c0941/compress_pickle-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-09-21 18:13:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lucianopaz",
"github_project": "compress_pickle",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "compress-pickle"
}
JSON
