Metadata-Version: 2.1
Name: rediswrapper
Version: 0.4.0.post1
Summary: Pythonic wrapper for Redis Client.
License: MIT
Keywords: redis,client,mock
Author-email: Frost Ming <mianghong@gmail.com>
Requires-Python: >=3.6
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development
Project-URL: Homepage, https://github.com/frostming/rediswrapper
Description-Content-Type: text/x-rst

Redis Wrapper
=============
.. image:: https://img.shields.io/pypi/v/rediswrapper.svg
  :target: https://pypi.org/project/rediswrapper
.. image:: https://img.shields.io/pypi/pyversions/rediswrapper.svg
  :target: https://pypi.org/project/rediswrapper
.. image:: https://github.com/frostming/rediswrapper/actions/workflows/ci.yml/badge.svg
  :target: https://github.com/frostming/rediswrapper/actions/workflows/ci.yml

*rediswrapper is a pythonic wrapper of Redis Client for end users. The whole storage
acts like a python dict as well as its child storage values.*

Features
--------
* The root client support dict-like operations
* Python object wrappers for list, set, hash type values
* Implicit serialization and deserialization when storing and fetching data

Installation
------------
From PyPI::

  pip install rediswrapper

From GitHub::

  git clone https://github.com/frostming/rediswrapper
  cd rediswrapper
  pip install .


Usage
-----

``rediswrapper`` will try to serialize non-sting values and store them in redis and
deserialize them when fetching back.

All redis value types are mocked with respective python objects and support all
standard methods as the builtin types.

.. code:: python

  >>> import rediswrapper
  >>> redis = rediswrapper.RedisDict()
  # String value
  >>> redis['a'] = 'hello'
  # int value
  >>> redis['b'] = 2
  >>> dict(redis)
  {'a': 'hello', 'b': 2}
  # Picklable object
  >>> import datetime
  >>> redis['c'] = datetime.datetime.now()
  # List value
  >>> redis['d'] = list(range(5))
  >>> redis['d'].append(0)
  >>> redis['d']
  ListType value([0, 1, 2, 3, 4, 0])
  # Hash value
  >>> redis['e'] = {'a': 1, 'b': 2}
  >>> redis['e'].get('a')
  1
  # Set value
  >>> redis['f'] = set([1, 2])
  >>> redis['f'].add(3)
  >>> redis['f']
  SetType value([1, 2, 3])

To inspect those value types, one should use the ABCs defined in ``collections``
module.

.. code:: python

  >>> from collections import Mapping
  >>> isinstance(redis['e'], Mapping)
  True

History
-------

v0.4.0
    * Drop support for Python older than 3.6

v0.3.0
    * Drop support for Python 3.3
    * Fix a vulnerability issue that cause users run arbitrary scripts.

Licensing
---------
This work is open-sourced under the `MIT <LICENSE>`_ license.

