{"id":27078740,"url":"https://github.com/pedneri1/elixir_s3_cached","last_synced_at":"2025-04-06T01:17:47.721Z","repository":{"id":56841852,"uuid":"332605453","full_name":"Pedneri1/elixir_s3_cached","owner":"Pedneri1","description":"Key/value access to AWS S3 with in-memory cache","archived":false,"fork":false,"pushed_at":"2021-03-07T21:31:05.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T03:03:22.372Z","etag":null,"topics":["cache","elixir","key-value","s3"],"latest_commit_sha":null,"homepage":"https://hex.pm/packages/elixir_s3_cached","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/Pedneri1.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-01-25T02:10:57.000Z","updated_at":"2021-03-07T21:29:52.000Z","dependencies_parsed_at":"2022-08-29T07:41:54.439Z","dependency_job_id":null,"html_url":"https://github.com/Pedneri1/elixir_s3_cached","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pedneri1%2Felixir_s3_cached","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pedneri1%2Felixir_s3_cached/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pedneri1%2Felixir_s3_cached/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pedneri1%2Felixir_s3_cached/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pedneri1","download_url":"https://codeload.github.com/Pedneri1/elixir_s3_cached/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247419889,"owners_count":20936021,"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":["cache","elixir","key-value","s3"],"created_at":"2025-04-06T01:17:46.660Z","updated_at":"2025-04-06T01:17:47.717Z","avatar_url":"https://github.com/Pedneri1.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ElixirS3Cached\n\n**TODO: Add description**\n\n## Installation\n\nIf [available in Hex](https://hex.pm/docs/publish), the package can be installed\nby adding `elixir_s3_cached` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:elixir_s3_cached, \"~\u003e 0.1.0\"}\n  ]\nend\n```\n\nDocumentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)\nand published on [HexDocs](https://hexdocs.pm). Once published, the docs can\nbe found at [https://hexdocs.pm/elixir_s3_cached](https://hexdocs.pm/elixir_s3_cached).\n\n## Using in your project\n\nIf you want to start the cache manually, you can call `ElixirS3Cached.start_link/3`\n\n```elixir\n{:ok, cache} = ElixirS3Cached.start_link(\"elixir-s3-cache\", %{})\n```\n\nand then, call the function `get/2`\n\n```elixir\nvalue = ElixirS3Cached.get(cache, \"key\")\n```\n\nor `set/3`\n\n```elixir\nElixirS3Cached.set(cache, \"key\", \"value\")\n```\n\n### There is an optional parameter if you want to use a prefix.\n\n```elixir\n{:ok, cache} = ElixirS3Cached.start_link(\"elixir-s3-cache\", %{}, \"prefix\")\n```\n\nUnder the hood the lib will prepend the given prefix to every key. So if you call the `get/2` function with a \"my-file.json\" key it will look for \"prefix/my-file.json\" inside S3.\n\nIf you want to invalidate the entire cache you can use the `clear/1` function:\n\n```elixir\nElixirS3Cached.clear(cache)\n```\n\n## Benchmarks\n\nThere are some benchmarkes available made with [Benchee](https://github.com/bencheeorg/benchee). You can find the script file under the `benchmarks/` directory. To run the benchmarks use the following command:\n\n```\n$ mix bench\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedneri1%2Felixir_s3_cached","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpedneri1%2Felixir_s3_cached","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedneri1%2Felixir_s3_cached/lists"}