Metadata-Version: 2.1
Name: blooms
Version: 0.1.0
Summary: Lightweight Bloom filter data structure derived from the built-in bytearray type.
Home-page: https://github.com/nthparty/blooms
Author: Andrei Lapets
Author-email: a@lapets.io
License: MIT
Description: ======
        blooms
        ======
        
        Lightweight Bloom filter data structure derived from the built-in bytearray type.
        
        |pypi| |travis| |coveralls|
        
        .. |pypi| image:: https://badge.fury.io/py/blooms.svg
           :target: https://badge.fury.io/py/blooms
           :alt: PyPI version and link.
        
        .. |travis| image:: https://travis-ci.com/nthparty/blooms.svg?branch=main
           :target: https://travis-ci.com/nthparty/blooms
        
        .. |coveralls| image:: https://coveralls.io/repos/github/nthparty/blooms/badge.svg?branch=main
           :target: https://coveralls.io/github/nthparty/blooms?branch=main
        
        Package Installation and Usage
        ------------------------------
        The package is available on PyPI::
        
            python -m pip install blooms
        
        The library can be imported in the usual ways::
        
            import blooms
            from blooms import blooms
        
        Testing and Conventions
        -----------------------
        All unit tests are executed and their coverage is measured when using `nose <https://nose.readthedocs.io/>`_ (see ``setup.cfg`` for configution details)::
        
            nosetests
        
        Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`_::
        
            python blooms/blooms.py -v
        
        Style conventions are enforced using `Pylint <https://www.pylint.org/>`_::
        
            pylint blooms
        
        Contributions
        -------------
        In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.
        
        Versioning
        ----------
        The version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`_.
        
Platform: UNKNOWN
Description-Content-Type: text/x-rst
