Metadata-Version: 2.1
Name: bloomfilter-py
Version: 0.0.6
Summary: Yet another bloomfilter implementation in Python
Home-page: https://github.com/OldPanda/bloomfilter-py
Author: OldPanda
Author-email: me@old-panda.com
License: MIT
Description: # bloomfilter-py
        ![](https://img.shields.io/pypi/v/bloomfilter-py.svg)
        ![](https://img.shields.io/pypi/pyversions/bloomfilter-py.svg)
        [![codecov](https://codecov.io/gh/OldPanda/bloomfilter-py/branch/master/graph/badge.svg?token=RBX1JK7P7O)](https://codecov.io/gh/OldPanda/bloomfilter-py)
        
        ## Overview
        Yet another Bloomfilter implementation in Python, compatible with Java's Guava library.
        
        I was looking for a Python library which is capable of reading what Bloomfilter of Java's Guava library serializes and is also able to output byte array which is recognizable by Java. But unfortunately failed. Hence I developed this library by borrowing how Guava implements Bloomfilter serialization/deserialization a lot to deal with Bloomfilters on both Python and Java sides.
        
        As for Bloomfilter usage in Java world, please refer to [this post](https://www.baeldung.com/guava-bloom-filter).
        
        Here's a brief [introduction](https://en.wikipedia.org/wiki/Bloom_filter) to Bloomfilter.
        
        ## Requirements
        * Python 3.7+
        
        This library is not tested under Python 3.6 and lower versions.
        
        ## Install
        ```
        pip install bloomfilter-py
        ```
        
        ## Usage Examples
        
        ### Basic Usage
        ```Python
        >>> from bloomfilter import BloomFilter
        >>> bloom_filter = BloomFilter(expected_insertions=500, err_rate=0.01)
        >>> for i in range(100):
        ...     bloom_filter.put(i)
        ...
        >>> 1 in bloom_filter
        True
        >>> 100 in bloom_filter
        False
        >>>
        ```
        
        ### Serialize Bloomfilter
        ```Python
        >>> dumps = bloom_filter.dumps()
        >>> with open("dumps.out", "wb") as f:
        ...     f.write(dumps)
        ...
        >>>
        ```
        
        ### Deserialize Bloomfilter
        ```Python
        >>> with open("dumps.out", "rb") as f:
        ...     bf = BloomFilter.loads(f.read())
        ...
        >>> 1 in bf
        True
        >>> 100 in bf
        False
        >>>
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
