{"id":18000175,"url":"https://github.com/jamesduncombe/petal","last_synced_at":"2025-04-04T07:44:04.138Z","repository":{"id":57531166,"uuid":"307783087","full_name":"jamesduncombe/petal","owner":"jamesduncombe","description":"Petal is a Bloom filter in Elixir... 🌺","archived":false,"fork":false,"pushed_at":"2020-11-16T17:48:49.000Z","size":24,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-09T19:14:20.602Z","etag":null,"topics":["bloom-filter","elixir"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jamesduncombe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-27T17:49:30.000Z","updated_at":"2023-01-26T10:56:21.000Z","dependencies_parsed_at":"2022-09-26T18:22:06.015Z","dependency_job_id":null,"html_url":"https://github.com/jamesduncombe/petal","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesduncombe%2Fpetal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesduncombe%2Fpetal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesduncombe%2Fpetal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesduncombe%2Fpetal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamesduncombe","download_url":"https://codeload.github.com/jamesduncombe/petal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247142043,"owners_count":20890652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bloom-filter","elixir"],"created_at":"2024-10-29T23:10:02.679Z","updated_at":"2025-04-04T07:44:04.118Z","avatar_url":"https://github.com/jamesduncombe.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Petal 🌺\n\n![tests](https://github.com/jamesduncombe/petal/workflows/tests/badge.svg)\n\nPetal is a [Bloom filter](https://en.wikipedia.org/wiki/Bloom_filter) in Elixir.\n\n## Usage\n\nYou can use Petal by adding it to your dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:petal, \"~\u003e 0.2.1\"}\n  ]\nend\n```\n\nThen within your config file you'll need to specify the hashing implementations to use:\n\n```elixir\nconfig :petal,\n  hashers: [\n    Petal.Hasher.Adler32,\n    Petal.Hasher.CRC32\n  ]\n```\n\nThe ones above are included with Petal. You are free to add your own though, just check [the\n documentation](https://hexdocs.pm/petal/Petal.Hasher.html) for how to implement your own.\n\nYou can set the size of the filter with the config setting `filter_size`:\n\n```elixir\nconfig :petal,\n  filter_size: 64\n```\n\nTo calculate what size filter you will need, you can use a handy calculator such as the one here: https://hur.st/bloomfilter.\n\nBy default this is set to 64 bits.\n\nDocumentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc). The docs can also be found at [https://hexdocs.pm/petal](https://hexdocs.pm/petal).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamesduncombe%2Fpetal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamesduncombe%2Fpetal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamesduncombe%2Fpetal/lists"}