# Tikray
[](https://github.com/panodata/tikray/actions/workflows/tests.yml)
[](https://app.codecov.io/gh/panodata/tikray)
[](https://tikray.readthedocs.io/)
[](https://pypi.org/project/tikray/)
[](https://pypi.org/project/tikray/)
[](https://pypi.org/project/tikray/)
[](https://pepy.tech/project/tikray/)
[](https://pypi.org/project/tikray/)
## About
Tikray is 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.
## Details
A data model and implementation for a compact transformation engine written
in [Python], based on [JSON Pointer] (RFC 6901), [JMESPath], and [transon],
implemented using [attrs] and [cattrs].
## Installation
The package is available from [PyPI] at [tikray].
To install the most recent version, invoke:
```shell
uv pip install --upgrade 'tikray'
```
## 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 [research and development notes],
specifically [an introduction and overview about Singer].
### Contributing
The `tikray` 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
Tikray means "transform" in the [Quechua language].
A previous version used the name `zyp`,
with kudos to [Kris Zyp] for conceiving [JSON Pointer].
### 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.
[An introduction and overview about Singer]: https://github.com/daq-tools/lorrystream/blob/main/doc/singer/intro.md
[documentation]: https://tikray.readthedocs.io/
[examples]: https://tikray.readthedocs.io/examples.html
[Kris Zyp]: https://github.com/kriszyp
[tikray]: https://pypi.org/project/tikray/
[Quechua language]: https://en.wikipedia.org/wiki/Quechua_language
[managed on GitHub]: https://github.com/panodata/tikray
[PyPI]: https://pypi.org/
[research and development notes]: https://tikray.readthedocs.io/research.html
[attrs]: https://www.attrs.org/
[cattrs]: https://catt.rs/
[DWIM]: https://en.wikipedia.org/wiki/DWIM
[jp]: https://github.com/jmespath/jp
[jq]: https://jqlang.github.io/jq/
[jsonpointer]: https://python-json-pointer.readthedocs.io/en/latest/commandline.html
[jqlang]: https://jqlang.github.io/jq/manual/
[JMESPath]: https://jmespath.org/
[JSON Pointer]: https://datatracker.ietf.org/doc/html/rfc6901
[Python]: https://en.wikipedia.org/wiki/Python_(programming_language)
[transon]: https://transon-org.github.io/
Raw data
{
"_id": null,
"home_page": null,
"name": "tikray",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.6",
"maintainer_email": null,
"keywords": "conversion, convert, data, decode, deserialize, encode, i/o, jmespath, json, jsonpointer, map data, marshal, nested data, serialize, sql, tool, transcode, transform, translate, transon, unmarshal, unserialize, utility",
"author": null,
"author_email": "Andreas Motl <andreas.motl@panodata.org>",
"download_url": "https://files.pythonhosted.org/packages/36/5c/6e251fdc0a769c631f56fd0f159e1fb7f9033347f5ae9c4735b421e3e307/tikray-0.0.23.tar.gz",
"platform": null,
"description": "# Tikray\n\n[](https://github.com/panodata/tikray/actions/workflows/tests.yml)\n[](https://app.codecov.io/gh/panodata/tikray)\n[](https://tikray.readthedocs.io/)\n[](https://pypi.org/project/tikray/)\n\n[](https://pypi.org/project/tikray/)\n[](https://pypi.org/project/tikray/)\n[](https://pepy.tech/project/tikray/)\n[](https://pypi.org/project/tikray/)\n\n## About\n\nTikray is a generic and compact **transformation engine** written in Python, for data\ndecoding, encoding, conversion, translation, transformation, and cleansing purposes,\nto be used as a pipeline element for data pre- and/or post-processing.\n\n## Details\n\nA data model and implementation for a compact transformation engine written\nin [Python], based on [JSON Pointer] (RFC 6901), [JMESPath], and [transon],\nimplemented using [attrs] and [cattrs].\n\n## Installation\n\nThe package is available from [PyPI] at [tikray].\nTo install the most recent version, invoke:\n```shell\nuv pip install --upgrade 'tikray'\n```\n\n## Usage\n\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 [research and development notes],\nspecifically [an introduction and overview about Singer].\n\n### Contributing\nThe `tikray` 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\nTikray means \"transform\" in the [Quechua language].\nA previous version used the name `zyp`,\nwith kudos to [Kris Zyp] for conceiving [JSON Pointer].\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[An introduction and overview about Singer]: https://github.com/daq-tools/lorrystream/blob/main/doc/singer/intro.md\n[documentation]: https://tikray.readthedocs.io/\n[examples]: https://tikray.readthedocs.io/examples.html\n[Kris Zyp]: https://github.com/kriszyp\n[tikray]: https://pypi.org/project/tikray/\n[Quechua language]: https://en.wikipedia.org/wiki/Quechua_language\n[managed on GitHub]: https://github.com/panodata/tikray\n[PyPI]: https://pypi.org/\n[research and development notes]: https://tikray.readthedocs.io/research.html\n\n[attrs]: https://www.attrs.org/\n[cattrs]: https://catt.rs/\n[DWIM]: https://en.wikipedia.org/wiki/DWIM\n[jp]: https://github.com/jmespath/jp\n[jq]: https://jqlang.github.io/jq/\n[jsonpointer]: https://python-json-pointer.readthedocs.io/en/latest/commandline.html\n[jqlang]: https://jqlang.github.io/jq/manual/\n[JMESPath]: https://jmespath.org/\n[JSON Pointer]: https://datatracker.ietf.org/doc/html/rfc6901\n[Python]: https://en.wikipedia.org/wiki/Python_(programming_language)\n[transon]: https://transon-org.github.io/\n",
"bugtrack_url": null,
"license": "LGPL 3, EUPL 1.2",
"summary": "A compact data transformation engine.",
"version": "0.0.23",
"project_urls": {
"Changelog": "https://tikray.readthedocs.io/changes.html",
"Documentation": "https://tikray.readthedocs.io/",
"Homepage": "https://tikray.readthedocs.io/",
"Issues": "https://github.com/panodata/tikray/issues",
"Repository": "https://github.com/panodata/tikray"
},
"split_keywords": [
"conversion",
" convert",
" data",
" decode",
" deserialize",
" encode",
" i/o",
" jmespath",
" json",
" jsonpointer",
" map data",
" marshal",
" nested data",
" serialize",
" sql",
" tool",
" transcode",
" transform",
" translate",
" transon",
" unmarshal",
" unserialize",
" utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ab676d85c8a378a3ab3474685e27fb658e9190a5acf83e1ba1517bdf12d3401",
"md5": "396d8efb9cf0ed29779b3cabaf3ccf65",
"sha256": "b8ab01618cfac70982bd020804a666101445244b20544cca16a8801ef3c9e288"
},
"downloads": -1,
"filename": "tikray-0.0.23-py3-none-any.whl",
"has_sig": false,
"md5_digest": "396d8efb9cf0ed29779b3cabaf3ccf65",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.6",
"size": 18091,
"upload_time": "2025-02-05T01:11:10",
"upload_time_iso_8601": "2025-02-05T01:11:10.279938Z",
"url": "https://files.pythonhosted.org/packages/9a/b6/76d85c8a378a3ab3474685e27fb658e9190a5acf83e1ba1517bdf12d3401/tikray-0.0.23-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "365c6e251fdc0a769c631f56fd0f159e1fb7f9033347f5ae9c4735b421e3e307",
"md5": "e8a3108b2e73b9a5cc99090c5de0a2b3",
"sha256": "960c8bd03c8c80a93897ebbec9806054aeb403846710fc2eb180f10029bfdb53"
},
"downloads": -1,
"filename": "tikray-0.0.23.tar.gz",
"has_sig": false,
"md5_digest": "e8a3108b2e73b9a5cc99090c5de0a2b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.6",
"size": 24871,
"upload_time": "2025-02-05T01:11:12",
"upload_time_iso_8601": "2025-02-05T01:11:12.049905Z",
"url": "https://files.pythonhosted.org/packages/36/5c/6e251fdc0a769c631f56fd0f159e1fb7f9033347f5ae9c4735b421e3e307/tikray-0.0.23.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-05 01:11:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "panodata",
"github_project": "tikray",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tikray"
}
JSON
