cuteuid 1.0.1
Generate cute UIDs, i.e. unique(ish) identifiers that are similar in appearance to UUIDs.
Requires Python: >=3.6

# cuteuid
Generate cute UIDs, i.e. unique(ish) identifiers that are similar in appearance to [UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier).

## Install
```bash
pip install cuteuid
```
View on PyPi via [https://pypi.org/project/cuteuid/](https://pypi.org/project/cuteuid/)

## Usage
```python
from cuteuid import generate_cuteuid

generate_cuteuid()                  # 1337 UID
# 3xampl3a-boy1-goa1-5ucc33dd3p7h
# d1v151on-5ho3-1w31-d1571ngu15ha
# 7ak351h3-k33p-175a-5ympa7h371c1

generate_cuteuid(hex_only=True)     # 1337 UID (hex only)
# 10adca9a-4057-5a13-901171ca1136
# 0ff1c1a1-50f7-f33d-43517a73b3d1
# ad01053a-9057-7311-c411d400da50

generate_cuteuid(emoji=True)        # EmojiUID
# ⛹‍♂️��‍♂️⬜️3️⃣��������➖����������➖������������➖������������‍♀️��❗️����������‍♂️��
# ������‍♂️������������������➖����‍♂️����➖��‍����������➖������������������‍♀️��‍♀️������
# ������‍♂️��������⛹️‍♀️➖��‍♀️��️‍♂️��‍♀️��➖��‍♂️��‍������➖����‍♂️��️����������������������

generate_cuteuid(                   # EmojiUID (flags only)
    emoji=True,
    flags_only=True
)
# ��������������������������������➖����������������➖��������������➖����������������������������������������������������������
# ������������������������������➖����������������➖����������������➖����������������������������������������������������������
# ������������������������������������������➖����������������➖����������������➖��������������‍☠️����������������������������

generate_cuteuid(                   # EmojiUID (smileys only)
    emoji=True,
    smileys_only=True
)
# ����������������➖��������➖��������➖������������������������
# ����������������➖��������➖��������➖������������������������
# ����������������➖��������➖��������➖������������������������
```

## Preprocess
To rerun 1337 text preprocesing (translating word list into 1337 and hex 1337), update `preprocess.py` to point `WORDLIST_URL` to a URL containing a valid JSON list of words and run:

```bash
make preprocess
```

## Disclaimer
This project is intended for entertainment purposes only - it is *not* recommended for use in your production or intended as a replacement to existing UUID generation mechanisms.  It *might* be a fun thing to include in your non-mission critical personal project(s), provided you're the right kind of weird.

## License
The MIT License (MIT)

Copyright (c) 2019 [Alex Redmon](http://www.alexredmon.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.