Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redisbloom/redisbloom-py
Python client for Redisbloom
https://github.com/redisbloom/redisbloom-py
bloom-filter python-client redis redis-client redisbloom
Last synced: about 13 hours ago
JSON representation
Python client for Redisbloom
- Host: GitHub
- URL: https://github.com/redisbloom/redisbloom-py
- Owner: RedisBloom
- License: bsd-3-clause
- Created: 2017-08-31T19:57:12.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T08:30:19.000Z (almost 2 years ago)
- Last Synced: 2024-11-17T01:08:22.816Z (2 days ago)
- Topics: bloom-filter, python-client, redis, redis-client, redisbloom
- Language: Python
- Homepage: https://redisbloom.io
- Size: 24.3 MB
- Stars: 76
- Watchers: 5
- Forks: 11
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/RedisBloom/redisbloom-py)
[](https://badge.fury.io/py/redisbloom)
[](https://github.com/RedisBloom/redisbloom-py/releases/latest)
[](https://codecov.io/gh/RedisBloom/redisbloom-py)
[](https://snyk.io/test/github/RedisBloom/redisbloom-py?targetFile=pyproject.toml)
[](https://lgtm.com/projects/g/RedisBloom/redisbloom-py/alerts/)
# Python client for RedisBloom
[](https://forum.redis.com/c/modules/redisbloom)
[](https://discord.gg/wXhwjCQ)
## Deprecation notice
As of [redis-py 4.0.0](https://pypi.org/project/redis/4.0.0) this library is deprecated. It's features have been merged into redis-py. Please either install it [from pypy](https://pypi.org/project/redis) or [the repo](https://github.com/redis/redis-py).
--------------------------------
redisbloom-py is a package that gives developers easy access to several probabilistic data structures. The package extends [redis-py](https://github.com/andymccurdy/redis-py)'s interface with RedisBloom's API.
### Installation
```
$ pip install redisbloom
```
### Usage example
```python
# Using Bloom Filter
from redisbloom.client import Client
rb = Client()
rb.bfCreate('bloom', 0.01, 1000)
rb.bfAdd('bloom', 'foo') # returns 1
rb.bfAdd('bloom', 'foo') # returns 0
rb.bfExists('bloom', 'foo') # returns 1
rb.bfExists('bloom', 'noexist') # returns 0
# Using Cuckoo Filter
from redisbloom.client import Client
rb = Client()
rb.cfCreate('cuckoo', 1000)
rb.cfAdd('cuckoo', 'filter') # returns 1
rb.cfAddNX('cuckoo', 'filter') # returns 0
rb.cfExists('cuckoo', 'filter') # returns 1
rb.cfExists('cuckoo', 'noexist') # returns 0
# Using Count-Min Sketch
from redisbloom.client import Client
rb = Client()
rb.cmsInitByDim('dim', 1000, 5)
rb.cmsIncrBy('dim', ['foo'], [5])
rb.cmsIncrBy('dim', ['foo', 'bar'], [5, 15])
rb.cmsQuery('dim', 'foo', 'bar') # returns [10, 15]
# Using Top-K
from redisbloom.client import Client
rb = Client()
rb.topkReserve('topk', 3, 20, 3, 0.9)
rb.topkAdd('topk', 'A', 'B', 'C', 'D', 'E', 'A', 'A', 'B',
'C', 'G', 'D', 'B', 'D', 'A', 'E', 'E')
rb.topkQuery('topk', 'A', 'B', 'C', 'D') # returns [1, 1, 0, 1]
rb.topkCount('topk', 'A', 'B', 'C', 'D') # returns [4, 3, 2, 3]
rb.topkList('topk') # returns ['A', 'B', 'E']
rb.topkListWithCount('topk') # returns ['A', 4, 'B', 3, 'E', 3]
```
### API
For complete documentation about RedisBloom's commands, refer to [RedisBloom's website](http://redisbloom.io).
### License
[BSD 3-Clause](https://github.com/RedisBloom/redisbloom-py/blob/master/LICENSE)
### Development
1. Create a virtualenv to manage your python dependencies, and ensure it's active.
```virtualenv -v venv```
2. Install [pypoetry](https://python-poetry.org/) to manage your dependencies.
```pip install poetry```
3. Install dependencies.
```poetry install```
[tox](https://tox.readthedocs.io/en/latest/) runs all tests as its default target. Running *tox* by itself will run unit tests. Ensure you have a running redis, with the module loaded.