Metadata-Version: 2.4
Name: philiprehberger-randstr
Version: 0.1.7
Summary: Generate random readable strings for various purposes
Project-URL: Homepage, https://github.com/philiprehberger/py-randstr#readme
Project-URL: Repository, https://github.com/philiprehberger/py-randstr
Project-URL: Issues, https://github.com/philiprehberger/py-randstr/issues
Project-URL: Changelog, https://github.com/philiprehberger/py-randstr/blob/main/CHANGELOG.md
Author: Philip Rehberger
License-Expression: MIT
License-File: LICENSE
Keywords: generator,password,random,string,token
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# philiprehberger-randstr

[![Tests](https://github.com/philiprehberger/py-randstr/actions/workflows/publish.yml/badge.svg)](https://github.com/philiprehberger/py-randstr/actions/workflows/publish.yml)
[![PyPI version](https://img.shields.io/pypi/v/philiprehberger-randstr.svg)](https://pypi.org/project/philiprehberger-randstr/)
[![License](https://img.shields.io/github/license/philiprehberger/py-randstr)](LICENSE)

Generate random readable strings for various purposes.

## Installation

```bash
pip install philiprehberger-randstr
```

## Usage

### Random Strings

```python
from philiprehberger_randstr import randstr

randstr(16)                       # "aBx4kLm9pQrS2tUv"
randstr(8, charset="lowercase")   # "abcdefgh"
```

### Tokens and Passwords

```python
from philiprehberger_randstr import token, password

token(32)       # URL-safe base64 token
password(16)    # "aB3$kLm!9pQr#2tU"
```

### Hex and Short IDs

```python
from philiprehberger_randstr import hex_str, uuid_short

hex_str(16)     # "a1b2c3d4e5f6a7b8"
uuid_short()    # "7f3a8b2c"
```

All generators use the `secrets` module for cryptographic security.

## API

- `randstr(length=16, charset="alphanumeric")` — Random string from charset
- `token(length=32)` — URL-safe base64 token
- `password(length=16, symbols, min_symbols, min_digits, min_upper)` — Strong password
- `hex_str(length=16)` — Random hex string
- `uuid_short(length=8)` — Short UUID-like hex ID


## Development

```bash
pip install -e .
python -m pytest tests/ -v
```

## License

MIT
