Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tgrk/humanids
Generate Human Readable IDs
https://github.com/tgrk/humanids
elixir elixir-library generator human-readable ids
Last synced: 17 days ago
JSON representation
Generate Human Readable IDs
- Host: GitHub
- URL: https://github.com/tgrk/humanids
- Owner: tgrk
- License: apache-2.0
- Created: 2019-12-18T23:35:36.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-22T14:49:58.000Z (about 5 years ago)
- Last Synced: 2024-10-29T12:59:44.226Z (2 months ago)
- Topics: elixir, elixir-library, generator, human-readable, ids
- Language: Elixir
- Size: 17.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HumanIDs
[](https://circleci.com/gh/tgrk/humanids/tree/master)
[](https://hex.pm/packages/humanids)
[](https://coveralls.io/github/tgrk/humanids?branch=master)
Simple Elixir library that generates human-readable ids from a list of nouns and adjectives. It makes ids easy
for communication with other humans.
Examples:
- dinasaurs-gorillas-20
- swam-burst-48
- abbled-enthusiastically-98
- mongooses-ran-41
- glided-meerkat-98
Even that these ids are reasonably random, it is recommended not to use them as primary ids. Depending on your use-case.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `humanids` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:humanids, "~> 0.1.0"}
]
end
```
## Benchmark
```bash
$ mix run benchmark/default.exs
Operating System: Linux
CPU Information: Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz
Number of Available Cores: 4
Available memory: 15.43 GB
Elixir 1.9.0
Erlang 22.0
Benchmark suite executing with the following configuration:
warmup: 2 s
time: 5 s
memory time: 0 ns
parallel: 1
inputs: none specified
Estimated total run time: 21 s
Benchmarking Generate 10 ids...
Benchmarking Generate 100 ids...
Benchmarking Genrate 1000 ids...
Name ips average deviation median 99th %
Generate 10 ids 1867.05 0.54 ms ±25.69% 0.51 ms 1.14 ms
Generate 100 ids 188.21 5.31 ms ±16.28% 5.11 ms 8.17 ms
Genrate 1000 ids 18.81 53.17 ms ±3.92% 52.79 ms 59.77 ms
Comparison:
Generate 10 ids 1867.05
Generate 100 ids 188.21 - 9.92x slower +4.78 ms
Genrate 1000 ids 18.81 - 99.27x slower +52.63 ms
```