Table of Contents

• 1. About the Project
  • 1.1. Features
• 2. Getting Started
  • 2.1. Prerequisites
  • 2.2. Installation
• 3. Usage
• 4. Roadmap
• 5. License
• 6. Contact
• 7. Acknowledgements

1. About the Project

1.1. Features

• Read and write data to a Cached Pickle File

2. Getting Started

2.1. Prerequisites

2.2. Installation

Install my-project with flit

git clone https://github.com/rpakishore/ak_cache.git
cd ak_cache
pip install flit
flit install

Alternatively, you can use pip

pip install ak_cache

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.

$ from ak_cache import Cache
$ cache_file = Cache(r'Path\to\Cache\file.pkl')
$ cache_file.write('This is a text')
$ cache_file.read()
'This is a text'

Encrypt your pickle file as below

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

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

4. Roadmap

• Add encryption option to the cache file

5. License

See LICENSE.txt for more information.

6. Contact

Arun Kishore - @rpakishore

Project Link: https://github.com/rpakishore/

7. Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

• Awesome README Template
• Banner Maker
• Shields.io
• Carbon