Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
pankajnits committed Sep 22, 2023
1 parent 5ab27e3 commit 52a7687
Show file tree
Hide file tree
Showing 13 changed files with 1,053 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,4 @@ cython_debug/
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
.idea/
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Release Notes
##1.0.0 (2023-09-22)
- Wrapper for redis cache to reduce boilerplate code in each project.
- Provides seamless integration with redis cache libraries.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
# redis_wrapper
# Redis Wrapper!

- This module aims to provide a lightweight abstraction over caching technologies like Redis.
- Currently, this module has a Redis wrapper. More wrappers for caching technologies like Memcached will added in future releases.

- Abstracts integration challenges of various libraries


### How to install
Open terminal and run below commands.
````
git clone [email protected]:tata1mg/cache_wrapper.git
cd cache_wrapper/
python3 setup.py install
cache_wrapper can be installed via
pip3 install git+ssh://[email protected]/tata1mg/cache_wrapper.git
````

### How to use
Add this library as dependency in your project.
This project is made public for use in selected projects.
Soon we will make open source version of this.


### How to raise issues
Please use github issues to raise any bug or feature request

### Discussions

Please use github discussions for any topic related to this project

### Contributions

Soon we will be inviting open source contributions.

### Supported python versions
3.7.x,3.8.x,3.9.x
4 changes: 4 additions & 0 deletions redis_wrapper/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
__all__ = ["RegisterRedis", "RedisCache"]

from .client import RedisCache
from .register_redis_connection import RegisterRedis
1 change: 1 addition & 0 deletions redis_wrapper/cache_hosts.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
cache_hosts = {}
Loading

0 comments on commit 52a7687

Please sign in to comment.