File: README.markdown

package info (click to toggle)
pybloomfiltermmap 0.3.11-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,656 kB
  • ctags: 835
  • sloc: ansic: 1,127; python: 297; makefile: 7
file content (37 lines) | stat: -rw-r--r-- 1,016 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# pybloomfiltermmap [![Build Status](https://secure.travis-ci.org/axiak/pybloomfiltermmap.png?branch=master)](http://travis-ci.org/axiak/pybloomfiltermmap)

The goal of `pybloomfiltermmap` is simple: to provide a fast, simple, scalable,
correct library for Bloom Filters in Python.

## Docs

See <http://axiak.github.com/pybloomfiltermmap/>.

## Overview

After you install, the interface to use is a cross between a file
interface and a ste interface. As an example:

    >>> fruit = pybloomfilter.BloomFilter(100000, 0.1, '/tmp/words.bloom')
    >>> fruit.extend(('apple', 'pear', 'orange', 'apple'))
    >>> len(fruit)
    3
    >>> 'mike' in fruit
    False

## Install

You may or may not want to use Cython. If you have it installed, the
setup file will build the C file from the pyx file. Otherwise, it will
skip that step automatically and build from the packaged C file.

To install:

   $ sudo python setup.py install

and you should be set.

## License

See the LICENSE file. It's under the MIT License.