Project description

Iron-Man is a bloom filter based Cython & C. It is designed to make getting started quick and easy, with the ability to scale up to complex applications. It began as a simple Instance around Redis.

Irom-Man offers suggestions, but doesn't enforce any dependencies or project layout. It is up to the developer to choose the tools and libraries they want to use.

Installing

Install and update using pip:

pip install -U iron-man

A Simple Example

from iron_man import LocalBloomFilter

lbf = LocalBloomFilter(capacity=10000,error=0.0001)

# check item is it in filter
print(lbf.is_contain("content"))

# add item to filter
lbf.add("content")
print(lbf.is_contain("content"))

A Redis Example

from iron_man import RedisBloomFilter
from redis import Redis

redis_conn:Redis = Redis()

lbf = RedisBloomFilter(capacity=100000000,error=0.0001,redis_conn=redis_conn,prime_length=True,filter_prefix="bf_test")
# show the how many string will used by redis.
# every string will use 512MB mem.
print(lbf.mem_block_counts) 
# check item is it in filter
print(lbf.is_contain("content"))

# add item to filter
lbf.add("content")
print(lbf.is_contain("content"))

# warning. normally, you don't need to clean BloomFilter.
lbf.clean() 

Links

• Releases: https://pypi.org/project/iron-man/
• Code: http://gitlab.nuist.pro:3000/aberstone/IronMan.git
• Issue tracker: http://gitlab.nuist.pro:3000/aberstone/IronMan/issues