{"id":16019583,"url":"https://github.com/iboard/bucketier","last_synced_at":"2025-07-19T17:02:40.020Z","repository":{"id":57481221,"uuid":"141805913","full_name":"iboard/bucketier","owner":"iboard","description":"A simple Elixir Dictionary Application","archived":false,"fork":false,"pushed_at":"2019-03-04T12:38:30.000Z","size":217,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-04T08:08:48.202Z","etag":null,"topics":["dictionary-application","elixir","elixir-lang","hex"],"latest_commit_sha":null,"homepage":"https://hex.pm/packages/bucktier","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/iboard.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-21T11:23:25.000Z","updated_at":"2019-03-04T12:38:31.000Z","dependencies_parsed_at":"2022-09-26T17:50:43.420Z","dependency_job_id":null,"html_url":"https://github.com/iboard/bucketier","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iboard%2Fbucketier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iboard%2Fbucketier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iboard%2Fbucketier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iboard%2Fbucketier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iboard","download_url":"https://codeload.github.com/iboard/bucketier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247283338,"owners_count":20913557,"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":["dictionary-application","elixir","elixir-lang","hex"],"created_at":"2024-10-08T17:04:50.407Z","updated_at":"2025-04-05T03:25:03.469Z","avatar_url":"https://github.com/iboard.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bucketier README\n\n[![Documentation](https://img.shields.io/badge/docs-hexpm-blue.svg)](http://hexdocs.pm/bucketier/)\n[![Documentation](https://travis-ci.com/iboard/bucketier.svg?branch=master)](https://travis-ci.com/iboard/bucketier)\n\n**Bucketier** is a simple _Dictionary_ application you can use to store\ndata in a simple _Bucket_ (Key/Value store).\n\nSee `Bucketier.Bucket` for more information.\n\n\n## Installation\n\nBucketier is [available as hex package](https://hex.pm/packages/bucketier), \nthe package can be installed by adding `bucketier` to your list of dependencies \nin `mix.exs` and optionally start it with your application:\n\n```elixir\ndef application do\n  [\n    applications: [:bucketier],     ### add :bucketier here\n    extra_applications: [:logger],\n    mod: {YourElixirApp.Application, []}\n  ]\nend\n\ndef deps do\n  [\n    {:bucketier, \"~\u003e 0.1\"}\n  ]\nend\n\n```\n\nDocumentation can be found at [https://hexdocs.pm/bucketier](https://hexdocs.pm/bucketier).\n\n## Examples\n\nThe best way to figure out how you can use this library is by having a look at \nthis [Test suite](https://github.com/iboard/hexpack-examples/blob/master/test/hexpack_examples_test.exs).\n\n\n### Put some items in a shopping list and retreive the bucket by name\n\n```elixir\n    alias Bucketier.Bucket\n    \n    Bucket.bucket(\"shopping list\")\n    |\u003e Bucket.put( 1, \"Milk\")\n    |\u003e Bucket.put( 2, \"Butter\")\n    |\u003e Bucket.put( 3, \"Bread\")\n    |\u003e Bucket.commit\n\n    Bucket.bucket(\"shopping list\")\n    #=\u003e %Bucketier.Bucket{ \n    #=\u003e  data: %{ 1 =\u003e \"Milk\", 2 =\u003e \"Butter\", 3 =\u003e \"Bread\"}, \n    #=\u003e  name: \"shopping list\"\n    #=\u003e }\n```\n\n`Bucket.bucket(\"bucket name\")` will return a struct of type `%Bucket{}`.\n`Bucket.put` will add keys to this structure but will not save the new\nstate to the `Bucketier` until you call `Bucket.commit(mybucket)`.\n\n### Put some items in a list and retreive values by keys later\n\n```elixir\n    alias Bucketier.Bucket\n    \n    Bucket.bucket(\"shopping list\")\n    |\u003e Bucket.put( 1, \"Milk\")\n    |\u003e Bucket.put( 2, \"Butter\")\n    |\u003e Bucket.put( 3, \"Bread\")\n    |\u003e Bucket.commit\n\n    Bucket.get(\"shopping list\", 2)\n    #=\u003e \"Butter\"\n\n    Bucket.keys(\"shopping list\")\n    #=\u003e [1,2,3]\n\n    Bucket.values(\"shopping list\")\n    #=\u003e [\"Milk, \"Butter\", \"Bread\"]\n```\n\n\n## Roadmap\n\nThe project is a sidekick from a project at our company and will hopefully\nmature over the next weeks.\n\nObviously, updating and deleting of entries, real persistence (on disc),\nand other features are missing and will follow.\n\n    \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiboard%2Fbucketier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiboard%2Fbucketier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiboard%2Fbucketier/lists"}