# py-serializable
[![shield_pypi-version]][link_pypi]
[![shield_conda-forge-version]][link_conda-forge]
[![shield_rtfd]][link_rtfd]
[![shield_gh-workflow-test]][link_gh-workflow-test]
[![shield_license]][license_file]
[![shield_twitter-follow]][link_twitter]
----
This Pythonic library provides a framework for serializing/deserializing Python classes to and from JSON and XML.
It relies upon the use of
[Python Properties](https://docs.python.org/3/library/functions.html?highlight=property#property) in your Python
classes.
Read the full [documentation][link_rtfd] for more details.
## Installation
Install this from [PyPi.org][link_pypi] using your preferred Python package manager.
Example using `pip`:
```shell
pip install py-serializable
```
Example using `poetry`:
```shell
poetry add py-serializable
```
## Usage
See the full [documentation][link_rtfd] or our [unit tests][link_unit_tests] for usage and details.
## Python Support
We endeavour to support all functionality for all [current actively supported Python versions](https://www.python.org/downloads/).
However, some features may not be possible/present in older Python versions due to their lack of support.
## Contributing
Feel free to open issues, bugreports or pull requests.
See the [CONTRIBUTING][contributing_file] file for details.
## Copyright & License
`py-serializable` is Copyright (c) Paul Horton 2022. All Rights Reserved.
Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.
See the [LICENSE][license_file] file for the full license.
[license_file]: https://github.com/madpah/serializable/blob/main/LICENSE
[contributing_file]: https://github.com/madpah/serializable/blob/main/CONTRIBUTING.md
[link_rtfd]: https://py-serializable.readthedocs.io/
[shield_gh-workflow-test]: https://img.shields.io/github/actions/workflow/status/madpah/serializable/python.yml?branch=main "build"
[shield_rtfd]: https://img.shields.io/readthedocs/py-serializable?logo=readthedocs&logoColor=white
[shield_pypi-version]: https://img.shields.io/pypi/v/py-serializable?logo=Python&logoColor=white&label=PyPI "PyPI"
[shield_conda-forge-version]: https://img.shields.io/conda/vn/conda-forge/py-serializable?logo=anaconda&logoColor=white&label=conda-forge "conda-forge"
[shield_license]: https://img.shields.io/github/license/madpah/serializable?logo=open%20source%20initiative&logoColor=white "license"
[shield_twitter-follow]: https://img.shields.io/badge/Twitter-follow-blue?logo=Twitter&logoColor=white "twitter follow"
[link_gh-workflow-test]: https://github.com/madpah/serializable/actions/workflows/python.yml?query=branch%3Amain
[link_pypi]: https://pypi.org/project/py-serializable/
[link_conda-forge]: https://anaconda.org/conda-forge/py-serializable
[link_twitter]: https://twitter.com/madpah
[link_unit_tests]: https://github.com/madpah/serializable/blob/main/tests
Raw data
{
"_id": null,
"home_page": "https://github.com/madpah/serializable#readme",
"name": "py-serializable",
"maintainer": "Jan Kowalleck",
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": "jan.kowalleck@gmail.com",
"keywords": "serialization, deserialization, JSON, XML",
"author": "Paul Horton",
"author_email": "paul.horton@owasp.org",
"download_url": "https://files.pythonhosted.org/packages/17/86/70bfc6531c028c81b60b37aa5fb67e35c733bed4b3fc851fbb52e2ae0bbc/py_serializable-1.0.3.tar.gz",
"platform": null,
"description": "# py-serializable\n\n[![shield_pypi-version]][link_pypi]\n[![shield_conda-forge-version]][link_conda-forge]\n[![shield_rtfd]][link_rtfd]\n[![shield_gh-workflow-test]][link_gh-workflow-test]\n[![shield_license]][license_file]\n[![shield_twitter-follow]][link_twitter]\n\n----\n\nThis Pythonic library provides a framework for serializing/deserializing Python classes to and from JSON and XML.\n\nIt relies upon the use of \n[Python Properties](https://docs.python.org/3/library/functions.html?highlight=property#property) in your Python\nclasses.\n\nRead the full [documentation][link_rtfd] for more details.\n\n## Installation\n\nInstall this from [PyPi.org][link_pypi] using your preferred Python package manager.\n\nExample using `pip`:\n\n```shell\npip install py-serializable\n```\n\nExample using `poetry`:\n\n```shell\npoetry add py-serializable\n```\n\n## Usage\n\nSee the full [documentation][link_rtfd] or our [unit tests][link_unit_tests] for usage and details.\n\n## Python Support\n\nWe endeavour to support all functionality for all [current actively supported Python versions](https://www.python.org/downloads/).\nHowever, some features may not be possible/present in older Python versions due to their lack of support.\n\n## Contributing\n\nFeel free to open issues, bugreports or pull requests. \nSee the [CONTRIBUTING][contributing_file] file for details.\n\n## Copyright & License\n\n`py-serializable` is Copyright (c) Paul Horton 2022. All Rights Reserved.\n\nPermission to modify and redistribute is granted under the terms of the Apache 2.0 license. \nSee the [LICENSE][license_file] file for the full license.\n\n[license_file]: https://github.com/madpah/serializable/blob/main/LICENSE\n[contributing_file]: https://github.com/madpah/serializable/blob/main/CONTRIBUTING.md\n[link_rtfd]: https://py-serializable.readthedocs.io/\n\n[shield_gh-workflow-test]: https://img.shields.io/github/actions/workflow/status/madpah/serializable/python.yml?branch=main \"build\"\n[shield_rtfd]: https://img.shields.io/readthedocs/py-serializable?logo=readthedocs&logoColor=white\n[shield_pypi-version]: https://img.shields.io/pypi/v/py-serializable?logo=Python&logoColor=white&label=PyPI \"PyPI\"\n[shield_conda-forge-version]: https://img.shields.io/conda/vn/conda-forge/py-serializable?logo=anaconda&logoColor=white&label=conda-forge \"conda-forge\"\n[shield_license]: https://img.shields.io/github/license/madpah/serializable?logo=open%20source%20initiative&logoColor=white \"license\"\n[shield_twitter-follow]: https://img.shields.io/badge/Twitter-follow-blue?logo=Twitter&logoColor=white \"twitter follow\"\n[link_gh-workflow-test]: https://github.com/madpah/serializable/actions/workflows/python.yml?query=branch%3Amain\n[link_pypi]: https://pypi.org/project/py-serializable/\n[link_conda-forge]: https://anaconda.org/conda-forge/py-serializable\n[link_twitter]: https://twitter.com/madpah\n[link_unit_tests]: https://github.com/madpah/serializable/blob/main/tests\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Library for serializing and deserializing Python Objects to and from JSON and XML.",
"version": "1.0.3",
"project_urls": {
"Bug Tracker": "https://github.com/madpah/serializable/issues",
"Documentation": "https://py-serializable.readthedocs.io/",
"Homepage": "https://github.com/madpah/serializable#readme",
"Repository": "https://github.com/madpah/serializable"
},
"split_keywords": [
"serialization",
" deserialization",
" json",
" xml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47258ef5e5dd0d848128f44e45ed8272052250dedbabbfaa431658f8c077db9b",
"md5": "f4c06c8836fe4e97677257787a5ea909",
"sha256": "afba815f465b9fe7ab1c1a56d1aa8880c8a9e67a6e28b7ed62d4696fa369caf8"
},
"downloads": -1,
"filename": "py_serializable-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4c06c8836fe4e97677257787a5ea909",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 20206,
"upload_time": "2024-04-04T11:42:30",
"upload_time_iso_8601": "2024-04-04T11:42:30.511294Z",
"url": "https://files.pythonhosted.org/packages/47/25/8ef5e5dd0d848128f44e45ed8272052250dedbabbfaa431658f8c077db9b/py_serializable-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "178670bfc6531c028c81b60b37aa5fb67e35c733bed4b3fc851fbb52e2ae0bbc",
"md5": "a07053f4156b7ecb6a1aa89a01dbdfa5",
"sha256": "da3cb4b1f3cc5cc5ebecdd3dadbabd5f65d764357366fa64ee9cbaf0d4b70dcf"
},
"downloads": -1,
"filename": "py_serializable-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "a07053f4156b7ecb6a1aa89a01dbdfa5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 51376,
"upload_time": "2024-04-04T11:42:32",
"upload_time_iso_8601": "2024-04-04T11:42:32.212550Z",
"url": "https://files.pythonhosted.org/packages/17/86/70bfc6531c028c81b60b37aa5fb67e35c733bed4b3fc851fbb52e2ae0bbc/py_serializable-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 11:42:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "madpah",
"github_project": "serializable#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "py-serializable"
}
JSON
