Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rpakishore/ak_cache

Python Caching library customized for AK's projects
https://github.com/rpakishore/ak_cache

python

Last synced: about 2 months ago
JSON representation

Python Caching library customized for AK's projects

Host: GitHub
URL: https://github.com/rpakishore/ak_cache
Owner: rpakishore
License: mit
Created: 2023-04-20T21:24:34.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-12T20:47:43.000Z (3 months ago)
Last Synced: 2024-10-11T09:34:57.103Z (2 months ago)
Topics: python
Language: Python
Homepage:
Size: 26.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  ak_cache

  

    Cache any data for your python projects

  






![GitHub commit activity](https://img.shields.io/github/commit-activity/m/rpakishore/ak_cache)

![GitHub last commit](https://img.shields.io/github/last-commit/rpakishore/ak_cache)

Table of Contents


- [1. About the Project](#1-about-the-project)

  - [1.1. Features](#11-features)

- [2. Getting Started](#2-getting-started)

  - [2.1. Installation](#21-installation)

- [3. Usage](#3-usage)

- [4. Roadmap](#4-roadmap)

- [5. License](#5-license)

- [6. Contact](#6-contact)

## 1. About the Project

### 1.1. Features

- Read and write data to a Cached Pickle File

## 2. Getting Started

### 2.1. Installation

```bash

pip install ak_cache

```

Alternatively

```bash

git install ak_cache@git+https://github.com/rpakishore/ak_cache.git

```

## 3. Usage

Use this space to tell a little more about your project and how it can be used. Show additional screenshots, code samples, demos or link to other resources.

```python

from ak_cache import Cache

cache_file = Cache(r'Path\to\Cache\file.pkl')

cache_file.write('This is a text')

cache_file.read()

```

Encrypt your pickle file as below

```python

cache_file = Cache(r'Path\to\Cache\encr_file.pkl', password="Strong_Password")

cache_file.write('This is an encrypted text')

cache_file.read()

```

## 4. Roadmap

- [x] Add encryption option to the cache file

## 5. License

See [LICENSE](./LICENSE) for more information.

## 6. Contact

Arun Kishore - [@rpakishore](mailto:[email protected])

Project Link: [https://github.com/rpakishore/ak_cache](https://github.com/rpakishore/ak_cache)