# commons-codec
[](https://github.com/crate/commons-codec/actions/workflows/tests.yml)
[](https://app.codecov.io/gh/crate/commons-codec)
[](https://commons-codec.readthedocs.io/)
[](https://pypi.org/project/commons-codec/)
[](https://pypi.org/project/commons-codec/)
[](https://pepy.tech/project/commons-codec/)
[](https://pypi.org/project/commons-codec/)
[](https://pypi.org/project/commons-codec/)
## About
> A codec is a device or computer program that encodes or decodes a data stream or signal.
> Codec is a portmanteau of coder/decoder.
>
> A coder or encoder encodes a data stream or a signal for transmission or storage,
> [...], and the decoder function reverses the encoding for playback or editing.
>
> -- https://en.wikipedia.org/wiki/Codec
## What's Inside
- [Change Data Capture (CDC)]: **Transformer components** for converging CDC event messages to
SQL statements.
- A collection of reusable utilities with minimal dependencies for
**decoding and transcoding** purposes, mostly collected from other projects like
[Kotori](https://kotori.readthedocs.io/) and [LorryStream](https://lorrystream.readthedocs.io/),
in order to provide them per standalone package for broader use cases.
- [Zyp], a generic and compact **transformation engine** written in Python, for data
decoding, encoding, conversion, translation, transformation, and cleansing purposes,
to be used as a pipeline element for data pre- and/or post-processing.
## Installation
The package is available from [PyPI] at [commons-codec].
To install the most recent version, including support for MongoDB, and Zyp, run:
```shell
pip install --upgrade 'commons-codec[mongodb,zyp]'
```
## Usage
In order to learn how to use the library, please visit the [documentation],
and explore the source code or its [examples].
## Project Information
### Acknowledgements
Kudos to the authors of all the many software components this library is
vendoring and building upon.
### Similar Projects
See [prior art] and [Zyp research].
### Contributing
The `commons-codec` package is an open source project, and is
[managed on GitHub]. The project is still in its infancy, and
we appreciate contributions of any kind.
### Etymology
The [Apache Commons Codec] library was the inspiration for the name. Otherwise,
both libraries' ingredients don't have anything in common, yet.
### License
The project uses the LGPLv3 license for the whole ensemble. However, individual
portions of the code base are vendored from other Python packages, where
deviating licenses may apply. Please check for detailed license information
within the header sections of relevant files.
[Apache Commons Codec]: https://commons.apache.org/proper/commons-codec/
[Change Data Capture (CDC)]: https://en.wikipedia.org/wiki/Change_data_capture
[commons-codec]: https://pypi.org/project/commons-codec/
[Zyp research]: https://commons-codec.readthedocs.io/zyp/research.html
[documentation]: https://commons-codec.readthedocs.io/
[examples]: https://github.com/crate/commons-codec/tree/main/examples
[managed on GitHub]: https://github.com/crate/commons-codec
[prior art]: https://commons-codec.readthedocs.io/prior-art.html
[PyPI]: https://pypi.org/
[Zyp]: https://commons-codec.readthedocs.io/zyp/
Raw data
{
"_id": null,
"home_page": null,
"name": "commons-codec",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.6",
"maintainer_email": null,
"keywords": "airrohr, bson, cdc, conversion, convert, data, decode, deserialize, dynamodb, encode, i/o, jmespath, json, jsonpointer, luftdaten.info, map data, marshal, mongodb, nested data, sensor.community, serialize, sql, tasmota, tool, transcode, transform, translate, transon, ttn, tts, unmarshal, unserialize, utility, zyp",
"author": null,
"author_email": "Andreas Motl <andreas.motl@panodata.org>",
"download_url": "https://files.pythonhosted.org/packages/9e/c2/595f58f86a3739a7a4fe0f432b03775aaedc3eb2762c3f70ed96b0243a55/commons_codec-0.0.21.tar.gz",
"platform": null,
"description": "# commons-codec\n\n[](https://github.com/crate/commons-codec/actions/workflows/tests.yml)\n[](https://app.codecov.io/gh/crate/commons-codec)\n[](https://commons-codec.readthedocs.io/)\n[](https://pypi.org/project/commons-codec/)\n[](https://pypi.org/project/commons-codec/)\n[](https://pepy.tech/project/commons-codec/)\n[](https://pypi.org/project/commons-codec/)\n[](https://pypi.org/project/commons-codec/)\n\n## About\n\n> A codec is a device or computer program that encodes or decodes a data stream or signal.\n> Codec is a portmanteau of coder/decoder.\n>\n> A coder or encoder encodes a data stream or a signal for transmission or storage,\n> [...], and the decoder function reverses the encoding for playback or editing.\n>\n> -- https://en.wikipedia.org/wiki/Codec\n\n## What's Inside\n- [Change Data Capture (CDC)]: **Transformer components** for converging CDC event messages to\n SQL statements.\n\n- A collection of reusable utilities with minimal dependencies for\n **decoding and transcoding** purposes, mostly collected from other projects like\n [Kotori](https://kotori.readthedocs.io/) and [LorryStream](https://lorrystream.readthedocs.io/),\n in order to provide them per standalone package for broader use cases.\n\n- [Zyp], a generic and compact **transformation engine** written in Python, for data\n decoding, encoding, conversion, translation, transformation, and cleansing purposes,\n to be used as a pipeline element for data pre- and/or post-processing.\n\n## Installation\nThe package is available from [PyPI] at [commons-codec].\nTo install the most recent version, including support for MongoDB, and Zyp, run:\n```shell\npip install --upgrade 'commons-codec[mongodb,zyp]'\n```\n\n## Usage\nIn order to learn how to use the library, please visit the [documentation],\nand explore the source code or its [examples].\n\n\n## Project Information\n\n### Acknowledgements\nKudos to the authors of all the many software components this library is\nvendoring and building upon.\n\n### Similar Projects\nSee [prior art] and [Zyp research].\n\n### Contributing\nThe `commons-codec` package is an open source project, and is\n[managed on GitHub]. The project is still in its infancy, and\nwe appreciate contributions of any kind.\n\n### Etymology\nThe [Apache Commons Codec] library was the inspiration for the name. Otherwise,\nboth libraries' ingredients don't have anything in common, yet.\n\n### License\nThe project uses the LGPLv3 license for the whole ensemble. However, individual\nportions of the code base are vendored from other Python packages, where\ndeviating licenses may apply. Please check for detailed license information\nwithin the header sections of relevant files.\n\n\n\n[Apache Commons Codec]: https://commons.apache.org/proper/commons-codec/\n[Change Data Capture (CDC)]: https://en.wikipedia.org/wiki/Change_data_capture\n[commons-codec]: https://pypi.org/project/commons-codec/\n[Zyp research]: https://commons-codec.readthedocs.io/zyp/research.html\n[documentation]: https://commons-codec.readthedocs.io/\n[examples]: https://github.com/crate/commons-codec/tree/main/examples\n[managed on GitHub]: https://github.com/crate/commons-codec\n[prior art]: https://commons-codec.readthedocs.io/prior-art.html\n[PyPI]: https://pypi.org/\n[Zyp]: https://commons-codec.readthedocs.io/zyp/\n",
"bugtrack_url": null,
"license": "LGPL 3, EUPL 1.2",
"summary": "Data decoding, encoding, conversion, and translation utilities.",
"version": "0.0.21",
"project_urls": {
"Changelog": "https://commons-codec.readthedocs.io/changes.html",
"Documentation": "https://commons-codec.readthedocs.io/",
"Homepage": "https://commons-codec.readthedocs.io/",
"Issues": "https://github.com/daq-tools/commons-codec/issues",
"Repository": "https://github.com/daq-tools/commons-codec"
},
"split_keywords": [
"airrohr",
" bson",
" cdc",
" conversion",
" convert",
" data",
" decode",
" deserialize",
" dynamodb",
" encode",
" i/o",
" jmespath",
" json",
" jsonpointer",
" luftdaten.info",
" map data",
" marshal",
" mongodb",
" nested data",
" sensor.community",
" serialize",
" sql",
" tasmota",
" tool",
" transcode",
" transform",
" translate",
" transon",
" ttn",
" tts",
" unmarshal",
" unserialize",
" utility",
" zyp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2bd622b5b840315cd55883bbdbba5e0fb79f1442aa8e983b7521d27e6d71684b",
"md5": "7b1e785de332161aa08a88c6b182d464",
"sha256": "006f51bf1300767d47cbaa8599d459f7ed0821c640692d3c7349de209b77c747"
},
"downloads": -1,
"filename": "commons_codec-0.0.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b1e785de332161aa08a88c6b182d464",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.6",
"size": 39568,
"upload_time": "2024-10-09T08:32:30",
"upload_time_iso_8601": "2024-10-09T08:32:30.583455Z",
"url": "https://files.pythonhosted.org/packages/2b/d6/22b5b840315cd55883bbdbba5e0fb79f1442aa8e983b7521d27e6d71684b/commons_codec-0.0.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ec2595f58f86a3739a7a4fe0f432b03775aaedc3eb2762c3f70ed96b0243a55",
"md5": "2766f57285e7330c9ccfa45b0f74ed00",
"sha256": "df69324cffcf144d0edf2fb3d57e73660da7ea3b6439fe0cf4b66d23a324e370"
},
"downloads": -1,
"filename": "commons_codec-0.0.21.tar.gz",
"has_sig": false,
"md5_digest": "2766f57285e7330c9ccfa45b0f74ed00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.6",
"size": 78377,
"upload_time": "2024-10-09T08:32:31",
"upload_time_iso_8601": "2024-10-09T08:32:31.874228Z",
"url": "https://files.pythonhosted.org/packages/9e/c2/595f58f86a3739a7a4fe0f432b03775aaedc3eb2762c3f70ed96b0243a55/commons_codec-0.0.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 08:32:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daq-tools",
"github_project": "commons-codec",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "commons-codec"
}
JSON
