| Name | bloomlib JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | https://www.mikehuls.com |
| Summary | Library that offers all types of Bloom filters, implemented in Rust |
| upload_time | 2024-11-01 13:11:50 |
| maintainer | None |
| docs_url | None |
| author | Mike Huls |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[//]: # (<div align="center">)
[//]: # ( <img src="https://pandas.pydata.org/static/img/pandas.svg"><br>)
[//]: # (</div>)
```commandline
______ ______ ___________ ______
___ /_ ___ /______ ______ _______ ___ ___ /___(_)___ /_
__ __ \__ / _ __ \_ __ \__ __ `__ \__ / __ / __ __ \
_ /_/ /_ / / /_/ // /_/ /_ / / / / /_ / _ / _ /_/ /
/_.___/ /_/ \____/ \____/ /_/ /_/ /_/ /_/ /_/ /_.___/
```
-----------------
# bloomlib: superfast Bloom filters for Python, optimized in Rust
| | |
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Testing |  |
| Package | [](https://pypi.org/project/bloomlib/) [](https://pypistats.org/packages/bloomlib) <br/>  |
| Meta |    |
| Social |   |
**bloomlib** is a Python package that provides superfast Bloom filters, designed to
optimize your applications in an easy and intuitive way.
It aims to be the go-to package to build and use Bloom Filters that make your applications
superfast, memory-efficient and user-friendly.
```shell
pip install bloomlib
```
## Table of Contents
- [Main Features](#main-features)
- [Usage Example](#usage-example)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [License](#license)
- [Documentation](#documentation)
- [Development](#development)
- [Contributing to bloomlib](#contributing-to-bloomlib)
## Main Features
- 🦀 Built in Rust
- ⚡ Highly optimized for speed and memory-efficiency
- 👨🎨 User-friendly
## Usage Example
```python
from bloomlib import BloomFilter
# 1. Create the filter
bf = BloomFilter(expected_number_of_items=1_000, desired_false_positive_rate=0.05)
# 2. Add items
for i in range(100):
bf.add(item=i)
# 3. Check if an item is contained; False means definitely not, True means "maybe"
if (bf.contains(item=42)):
print("This item may be in filter")
else:
print("This item is definitely not in the filter")
```
## Installation
```sh
pip install bloomlib
```
The source code is currently hosted on GitHub at:
https://github.com/mike-huls/bloomlib
Binary installers for the latest released version are available at the [Python
Package Index (PyPI)](https://pypi.org/project/bloomlib).
## Dependencies
Bloomlib has no Python dependencies
## License
[MIT](LICENSE.txt)
## Documentation
🔨 Under construction
## Development
Find the changelog and list of upcoming features [here](doc/CHANGELOG.md).
<br>
**Contributions** are always welcome; feel free to submit bug reports, bug fixes, feature requests, documentation improvements or enhancements!
<hr>
[Go to Top](#table-of-contents)
Raw data
{
"_id": null,
"home_page": "https://www.mikehuls.com",
"name": "bloomlib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Mike Huls",
"author_email": "mikehuls42@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/1e/b0887395b191b441ce30ff133feb42a1a3ede4153913f6014eb06f317b7c/bloomlib-0.0.3.tar.gz",
"platform": null,
"description": "[//]: # (<div align=\"center\">)\n[//]: # ( <img src=\"https://pandas.pydata.org/static/img/pandas.svg\"><br>)\n[//]: # (</div>)\n\n```commandline\n______ ______ ___________ ______ \n___ /_ ___ /______ ______ _______ ___ ___ /___(_)___ /_ \n__ __ \\__ / _ __ \\_ __ \\__ __ `__ \\__ / __ / __ __ \\\n_ /_/ /_ / / /_/ // /_/ /_ / / / / /_ / _ / _ /_/ /\n/_.___/ /_/ \\____/ \\____/ /_/ /_/ /_/ /_/ /_/ /_.___/ \n```\n-----------------\n\n# bloomlib: superfast Bloom filters for Python, optimized in Rust\n\n| | |\n|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Testing |  |\n| Package | [](https://pypi.org/project/bloomlib/) [](https://pypistats.org/packages/bloomlib) <br/>  |\n| Meta |    |\n| Social |   | \n\n**bloomlib** is a Python package that provides superfast Bloom filters, designed to \noptimize your applications in an easy and intuitive way.\nIt aims to be the go-to package to build and use Bloom Filters that make your applications \nsuperfast, memory-efficient and user-friendly.\n```shell\npip install bloomlib\n```\n\n## Table of Contents\n- [Main Features](#main-features)\n- [Usage Example](#usage-example)\n- [Installation](#installation)\n- [Dependencies](#dependencies)\n- [License](#license)\n- [Documentation](#documentation)\n- [Development](#development)\n- [Contributing to bloomlib](#contributing-to-bloomlib)\n\n## Main Features\n- \ud83e\udd80 Built in Rust\n- \u26a1 Highly optimized for speed and memory-efficiency\n- \ud83d\udc68\u200d\ud83c\udfa8 User-friendly\n\n## Usage Example\n```python\nfrom bloomlib import BloomFilter\n\n# 1. Create the filter\nbf = BloomFilter(expected_number_of_items=1_000, desired_false_positive_rate=0.05)\n\n# 2. Add items\nfor i in range(100):\n bf.add(item=i)\n\n# 3. Check if an item is contained; False means definitely not, True means \"maybe\" \nif (bf.contains(item=42)):\n print(\"This item may be in filter\")\nelse:\n print(\"This item is definitely not in the filter\")\n```\n\n\n## Installation\n```sh\npip install bloomlib\n```\nThe source code is currently hosted on GitHub at:\nhttps://github.com/mike-huls/bloomlib\n\nBinary installers for the latest released version are available at the [Python\nPackage Index (PyPI)](https://pypi.org/project/bloomlib).\n\n## Dependencies\nBloomlib has no Python dependencies\n\n## License\n[MIT](LICENSE.txt)\n\n## Documentation\n\ud83d\udd28 Under construction\n\n## Development\nFind the changelog and list of upcoming features [here](doc/CHANGELOG.md).\n<br>\n**Contributions** are always welcome; feel free to submit bug reports, bug fixes, feature requests, documentation improvements or enhancements!\n\n<hr>\n\n[Go to Top](#table-of-contents)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library that offers all types of Bloom filters, implemented in Rust",
"version": "0.0.3",
"project_urls": {
"Bug Tracker": "https://github.com/mike-huls/bloomlib/issues",
"Documentation": "https://github.com/mike-huls/bloomlib/blob/master/README.md/",
"Homepage": "https://github.com/mike-huls/bloomlib",
"Say Thanks!": "https://www.buymeacoffee.com/mikehuls",
"Source": "https://github.com/mike-huls/bloomlib/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "33972010cda687415abcd37c91b8c095fa4a09c1b39643975b5fca0d064fbd57",
"md5": "6b4fc6f9e8f9516e8528901ab65b1856",
"sha256": "a6443429eb2ca695b71734d61a8fe81362477d1d03b139b115a2c3cd8e50bb86"
},
"downloads": -1,
"filename": "bloomlib-0.0.3-cp39-cp39-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "6b4fc6f9e8f9516e8528901ab65b1856",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 260145,
"upload_time": "2024-11-01T13:11:46",
"upload_time_iso_8601": "2024-11-01T13:11:46.451089Z",
"url": "https://files.pythonhosted.org/packages/33/97/2010cda687415abcd37c91b8c095fa4a09c1b39643975b5fca0d064fbd57/bloomlib-0.0.3-cp39-cp39-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ba1eb0887395b191b441ce30ff133feb42a1a3ede4153913f6014eb06f317b7c",
"md5": "77395f07f56f02b34fff391d563a344a",
"sha256": "e6239dc2de24a0c249918bf9ecdd1022c71db3507ac449bb590c3ba7a8dfc48c"
},
"downloads": -1,
"filename": "bloomlib-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "77395f07f56f02b34fff391d563a344a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15934660,
"upload_time": "2024-11-01T13:11:50",
"upload_time_iso_8601": "2024-11-01T13:11:50.517370Z",
"url": "https://files.pythonhosted.org/packages/ba/1e/b0887395b191b441ce30ff133feb42a1a3ede4153913f6014eb06f317b7c/bloomlib-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 13:11:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mike-huls",
"github_project": "bloomlib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bloomlib"
}
