https://github.com/undertone0809/cushy-storage

An ORM framework based on disk caching for easy data and object storage.
https://github.com/undertone0809/cushy-storage

orm python

Last synced: about 2 months ago
JSON representation

An ORM framework based on disk caching for easy data and object storage.

• Host: GitHub
• URL: https://github.com/undertone0809/cushy-storage
• Owner: Undertone0809
• License: apache-2.0
• Created: 2023-03-08T14:29:25.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-02T09:00:11.000Z (5 months ago)
• Last Synced: 2024-10-02T15:04:50.253Z (3 months ago)
• Topics: orm, python
• Language: Python
• Homepage: https://undertone0809.github.io/cushy-storage/
• Size: 206 KB
• Stars: 14
• Watchers: 1
• Forks: 1
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


    cushy-storage





  An ORM framework based on disk caching





    

        

    

    

        

   

    

        

   

    

        

    



[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.