ShortUUID

ShortUUID is a simple UUID shortener library for Elixir inspired by shortuuid. When used with the same alphabet it should be compatible with the python versions encoder/decoder. This library does not however support generating UUIDs, some libraries that can be used for that purpose are Elixir UUID and Erlang UUID and also Ecto.

Installation

1. Add ShortUUID to your list of dependencies in mix.exs:

    def deps do
      [{:shortuuid, "~> 0.1.1"}]
    end

2. Optionally configure the alphabet to be used for encoding in config.exs:

    config :shortuuid,
      alphabet: "23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"

   The default alphabet (above) will translate UUIDs to base57 using lowercase and uppercase letters and digits while avoiding similar-looking characters such as l, 1, I, O and 0.

   When using a custom alphabet take care to avoid duplicate characters and be aware that order affects the encoding.

The full documentation can found at https://hexdocs.pm/shortuuid.