Metadata-Version: 2.1
Name: random-strings
Version: 0.1.1
Summary: strings that are ✨ random ✨
Home-page: https://github.com/dheerajreal/random-strings/
License: MIT
Project-URL: Bug Reports, https://github.com/dheerajreal/random-strings/issues/
Project-URL: Source, https://github.com/dheerajreal/random-strings/
Keywords: random,strings,utilities,security
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# random-strings

Generate strings that are ✨ random ✨

## how to install

```bash
$ pip install random-strings
```

## how to use

```python

>>> from random_strings import random_string
>>> random_string(5)
'YSuz5'

```

## advanced usage

```python
from random_strings import random_hex, random_string

password = random_string(16)
SECRET_KEY = random_string(64)

# hexadecimal characters
SECURE_TOKEN = random_hex(128)

# no uppercase letters
verification_code = random_string(12,upper=False)
# only uppercase letters
verification_code = random_string(12,lower=False,digit=False)

# custom characters
characters = '23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
verification_code = random_string(12,character_string=characters)

```

## more examples

```python

>>> from random_strings import *

>>> random_hex(16)
'ec583ef0aaa226cba9cb07e3dc2e623c'

>>> random_uuid()
'85273146-3ad8-489f-9964-e7af16ab6a26'

>>> random_uuid(dashes=False)
'a33ee36ad08242e4a2a819147f084a51'
```

## more details

Generated strings are suitable for cryptographically secure usecase

See `os.urandom`, `random.SystemRandom` and PEP 506 for more details on how it works.

also, this package is named `random-strings`.
There are other packages on pypi with similar names but they don't do the same thing.


