<h1 align="center">
cushy-storage
</h1>
<p align="center">
<strong>An ORM framework based on disk caching</strong>
</p>
<p align="center">
<a target="_blank" href="">
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?label=license" />
</a>
<a target="_blank" href=''>
<img src="https://static.pepy.tech/personalized-badge/cushy-storage?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads/Total"/>
</a>
<a target="_blank" href=''>
<img src="https://static.pepy.tech/personalized-badge/cushy-storage?period=month&units=international_system&left_color=grey&right_color=blue&left_text=Downloads/Week"/>
</a>
<a target="_blank" href=''>
<img src="assets/coverage.svg"/>
</a>
</p>
[English](/README.md) [中文](/README_zh.md)
# Introduction
cushy-storage is an ORM framework based on disk caching that allows you to easily perform CRUD operations on your custom data through ORM. On the other hand, cushy-storage saves you the effort of devising a data storage standard. Dictionary-like operations can reduce a lot of development costs. If you have a need for local file data operations, this framework can facilitate local data storage with ease.
# Features
- Supports ORM storage, basic data storage, and custom data storage, compatible with all data types
- Supports ORM framework-level object operations, enabling easy CRUD operations on object-level data
- Basic data storage operations are as simple as dict read and write, very convenient
- Easily perform local disk storage of data (basic data types, custom data types)
- Eliminates the need for direct file handling
- Provides multiple serialization options
- Offers various data compression methods
# Quick Start
- [Official documentation on github-pages](https://undertone0809.github.io/cushy-storage/#/)
- [Current development plan](https://undertone0809.github.io/cushy-storage/#/plan)
- [Contribution/Developer's manual](https://undertone0809.github.io/cushy-storage/#/contribution)
- [Frequently Asked Questions](https://undertone0809.github.io/cushy-storage/#/qa)
- [pypi repository](https://pypi.org/project/cushy-storage/)
# Installation
```bash
pip install cushy-storage -U
```
# Getting Started
The use of `cushy-storage` is mainly divided into four parts: `CushyOrmCache`, `CushyDict`, `BaseDict`, `disk_cache`. For more detailed information, please read the relevant documentation.
- [CushyORMCache](https://undertone0809.github.io/cushy-storage/#/cushy-orm-cache?id=cushyormcache)
Object storage based on the ORM framework, which allows for very convenient CRUD operations on object-level data.
- [CushyDict](https://undertone0809.github.io/cushy-storage/#/cushy-dict): An enhanced version of `BaseDict`, storing various types of data, including basic data types and custom data types.
- [BaseDict](https://undertone0809.github.io/cushy-storage/#/base-dict): Stores basic binary data.
- [disk_cache](https://undertone0809.github.io/cushy-storage/#/disk-cache): Function data caching.
# Contribution
If you want to contribute to this project, you can submit a PR or issue. I am happy to see more people get involved and improve it.
Raw data
{
"_id": null,
"home_page": "https://github.com/Undertone0809/cushy-storage",
"name": "cushy-storage",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "storage, ORM, serialization, json, cushy-storage, cushy_storage",
"author": "Zeeland",
"author_email": "zeeland4work@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/11/0c/12b584d960aec3096052530256a3c319420038b3bc49c9d8c544f01ea9da/cushy_storage-1.3.8.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n cushy-storage\n</h1>\n<p align=\"center\">\n <strong>An ORM framework based on disk caching</strong>\n</p>\n\n<p align=\"center\">\n <a target=\"_blank\" href=\"\">\n <img src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg?label=license\" />\n </a>\n <a target=\"_blank\" href=''>\n <img src=\"https://static.pepy.tech/personalized-badge/cushy-storage?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads/Total\"/>\n </a>\n <a target=\"_blank\" href=''>\n <img src=\"https://static.pepy.tech/personalized-badge/cushy-storage?period=month&units=international_system&left_color=grey&right_color=blue&left_text=Downloads/Week\"/>\n </a>\n <a target=\"_blank\" href=''>\n <img src=\"assets/coverage.svg\"/>\n </a>\n</p>\n\n[English](/README.md) [\u4e2d\u6587](/README_zh.md)\n\n# Introduction\n\ncushy-storage is an ORM framework based on disk caching that allows you to easily perform CRUD operations on your custom data through ORM. On the other hand, cushy-storage saves you the effort of devising a data storage standard. Dictionary-like operations can reduce a lot of development costs. If you have a need for local file data operations, this framework can facilitate local data storage with ease.\n\n# Features\n\n- Supports ORM storage, basic data storage, and custom data storage, compatible with all data types\n- Supports ORM framework-level object operations, enabling easy CRUD operations on object-level data\n- Basic data storage operations are as simple as dict read and write, very convenient\n- Easily perform local disk storage of data (basic data types, custom data types)\n- Eliminates the need for direct file handling\n- Provides multiple serialization options\n- Offers various data compression methods\n\n# Quick Start\n\n- [Official documentation on github-pages](https://undertone0809.github.io/cushy-storage/#/)\n- [Current development plan](https://undertone0809.github.io/cushy-storage/#/plan)\n- [Contribution/Developer's manual](https://undertone0809.github.io/cushy-storage/#/contribution)\n- [Frequently Asked Questions](https://undertone0809.github.io/cushy-storage/#/qa)\n- [pypi repository](https://pypi.org/project/cushy-storage/)\n\n# Installation\n\n```bash\npip install cushy-storage -U\n```\n\n# Getting Started\n\nThe use of `cushy-storage` is mainly divided into four parts: `CushyOrmCache`, `CushyDict`, `BaseDict`, `disk_cache`. For more detailed information, please read the relevant documentation.\n\n- [CushyORMCache](https://undertone0809.github.io/cushy-storage/#/cushy-orm-cache?id=cushyormcache)\n Object storage based on the ORM framework, which allows for very convenient CRUD operations on object-level data.\n- [CushyDict](https://undertone0809.github.io/cushy-storage/#/cushy-dict): An enhanced version of `BaseDict`, storing various types of data, including basic data types and custom data types.\n- [BaseDict](https://undertone0809.github.io/cushy-storage/#/base-dict): Stores basic binary data.\n- [disk_cache](https://undertone0809.github.io/cushy-storage/#/disk-cache): Function data caching.\n\n# Contribution\n\nIf you want to contribute to this project, you can submit a PR or issue. I am happy to see more people get involved and improve it.\n",
"bugtrack_url": null,
"license": null,
"summary": "A data local persistence ORM framework.",
"version": "1.3.8",
"project_urls": {
"Homepage": "https://github.com/Undertone0809/cushy-storage",
"Repository": "https://github.com/Undertone0809/cushy-storage"
},
"split_keywords": [
"storage",
" orm",
" serialization",
" json",
" cushy-storage",
" cushy_storage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b728bb83650f41c58eed97a924ce5ec837fe4368040a3cae516f34c520d1965",
"md5": "d333df209b98da88253923a0c4455bc5",
"sha256": "683f58fea2d05897f02ac24e80b4aff06ab45238e254ecbe933bc5d459c5b53f"
},
"downloads": -1,
"filename": "cushy_storage-1.3.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d333df209b98da88253923a0c4455bc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 16657,
"upload_time": "2024-04-10T11:26:58",
"upload_time_iso_8601": "2024-04-10T11:26:58.417248Z",
"url": "https://files.pythonhosted.org/packages/5b/72/8bb83650f41c58eed97a924ce5ec837fe4368040a3cae516f34c520d1965/cushy_storage-1.3.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "110c12b584d960aec3096052530256a3c319420038b3bc49c9d8c544f01ea9da",
"md5": "34cff2c839280c4eec1d2a6f65465cf3",
"sha256": "82e5af7329da08d0190d26f4cc9a217eac74c94754570e80429dedf6421c48db"
},
"downloads": -1,
"filename": "cushy_storage-1.3.8.tar.gz",
"has_sig": false,
"md5_digest": "34cff2c839280c4eec1d2a6f65465cf3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 13842,
"upload_time": "2024-04-10T11:27:00",
"upload_time_iso_8601": "2024-04-10T11:27:00.134331Z",
"url": "https://files.pythonhosted.org/packages/11/0c/12b584d960aec3096052530256a3c319420038b3bc49c9d8c544f01ea9da/cushy_storage-1.3.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 11:27:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Undertone0809",
"github_project": "cushy-storage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "loguru",
"specs": [
[
"==",
"0.7.2"
]
]
},
{
"name": "win32-setctime",
"specs": [
[
"==",
"1.1.0"
]
]
}
],
"lcname": "cushy-storage"
}
JSON
