| Name | xattrs JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | An eXtensible serializing and deserializing toolkit for Python strucuted classes |
| upload_time | 2024-10-09 04:42:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
attrs
cattrs
serde
json
schema
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# xattrs
[](https://pypi.org/project/xattrs)
[](https://pypi.org/project/xattrs)
---
Serialize and deserialize instances of your `attrs` and `dataclasses` types with implicit or customized encoding.
🚧 **WIP**
**Table of Contents**
- [Installation](#installation)
- [How to contribute](#how-to-contribute)
- [License](#license)
## Introduction
<!-- "correct by construction" instead of "correct by validation" / "correct by schema" -->
## Project orient
Let dataclasses or attrs just store declaretive and immutable 'data'.
Goals:
- Easy to use, easy to extend, easy to customize.
- Extending upstream project as more as its recommended ways, see also [`attrs` Extending](https://www.attrs.org/en/stable/extending.html).
Non-goals:
## Installation
```console
pip install xattrs
```
## How to contribute
The first and the best way to contribute to `xattrs` is to use it in your project and give feedback on your experience about it both good and bad. You could participate our community by submitting [issues]() or even pull requests, not limited to bugs, but also proposals, documentation, use cases and best practices.
Then you could also try to help us to improve the project by promoting it to your teams, writing blog posts, or even giving a talk in your local community.
If you have did all above, but still thought you could do more. Consider to sponsor the project for long-term maintenance and development.
The most important thing is the community, and we are looking forward to how people enjoy using `xattrs` and how it could help them to solve their problems.
## Development Guide
### Major upstream dependencies
- `attrs`
- `dataclasses`
- `annotated`
## License
`xattrs` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "xattrs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "attrs, cattrs, serde, json, schema",
"author": null,
"author_email": "Lanqing Huang <lqhuang@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/b1/7c/fd0c498099808dcf398164535d2eb7d144e526c82e93874f034c3c6dbb9b/xattrs-0.0.1.tar.gz",
"platform": null,
"description": "# xattrs\n\n[](https://pypi.org/project/xattrs)\n\n[](https://pypi.org/project/xattrs)\n\n---\n\nSerialize and deserialize instances of your `attrs` and `dataclasses` types with implicit or customized encoding.\n\n\ud83d\udea7 **WIP**\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [How to contribute](#how-to-contribute)\n- [License](#license)\n\n## Introduction\n\n<!-- \"correct by construction\" instead of \"correct by validation\" / \"correct by schema\" -->\n\n## Project orient\n\nLet dataclasses or attrs just store declaretive and immutable 'data'.\n\nGoals:\n\n- Easy to use, easy to extend, easy to customize.\n- Extending upstream project as more as its recommended ways, see also [`attrs` Extending](https://www.attrs.org/en/stable/extending.html).\n\nNon-goals:\n\n## Installation\n\n```console\npip install xattrs\n```\n\n## How to contribute\n\nThe first and the best way to contribute to `xattrs` is to use it in your project and give feedback on your experience about it both good and bad. You could participate our community by submitting [issues]() or even pull requests, not limited to bugs, but also proposals, documentation, use cases and best practices.\n\nThen you could also try to help us to improve the project by promoting it to your teams, writing blog posts, or even giving a talk in your local community.\n\nIf you have did all above, but still thought you could do more. Consider to sponsor the project for long-term maintenance and development.\n\nThe most important thing is the community, and we are looking forward to how people enjoy using `xattrs` and how it could help them to solve their problems.\n\n## Development Guide\n\n### Major upstream dependencies\n\n- `attrs`\n- `dataclasses`\n- `annotated`\n\n## License\n\n`xattrs` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An eXtensible serializing and deserializing toolkit for Python strucuted classes",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://github.com/lqhuang/xattrs#readme",
"Issues": "https://github.com/lqhuang/xattrs/issues",
"Source": "https://github.com/lqhuang/xattrs"
},
"split_keywords": [
"attrs",
" cattrs",
" serde",
" json",
" schema"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "361337a0d0376fe5e59f50bc59d4ca44ad7f7afd98d5d29d11af2df707bc6728",
"md5": "d5da91849d6c7884861bddd99fff5a59",
"sha256": "682fc59760fb606e1ed4aee304798e039d2c0fd9cc1a38f27805e0f3b67bb7fb"
},
"downloads": -1,
"filename": "xattrs-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5da91849d6c7884861bddd99fff5a59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 27115,
"upload_time": "2024-10-09T04:42:01",
"upload_time_iso_8601": "2024-10-09T04:42:01.304019Z",
"url": "https://files.pythonhosted.org/packages/36/13/37a0d0376fe5e59f50bc59d4ca44ad7f7afd98d5d29d11af2df707bc6728/xattrs-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b17cfd0c498099808dcf398164535d2eb7d144e526c82e93874f034c3c6dbb9b",
"md5": "6a7a4ba966b4eec48b7d9fb72daeed35",
"sha256": "b53d23bf375656297fe69dadd19d9ae4d660be55b90bed95a8e0787e5f4bfea4"
},
"downloads": -1,
"filename": "xattrs-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "6a7a4ba966b4eec48b7d9fb72daeed35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 24027,
"upload_time": "2024-10-09T04:42:03",
"upload_time_iso_8601": "2024-10-09T04:42:03.378279Z",
"url": "https://files.pythonhosted.org/packages/b1/7c/fd0c498099808dcf398164535d2eb7d144e526c82e93874f034c3c6dbb9b/xattrs-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 04:42:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lqhuang",
"github_project": "xattrs#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "xattrs"
}
