Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 3.17 KB

README.md

File metadata and controls

65 lines (50 loc) · 3.17 KB
Raw

cushy-storage

An ORM framework based on disk caching

English 中文

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

Installation

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 Object storage based on the ORM framework, which allows for very convenient CRUD operations on object-level data.
  • CushyDict: An enhanced version of BaseDict, storing various types of data, including basic data types and custom data types.
  • BaseDict: Stores basic binary data.
  • 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.