Metadata-Version: 2.5
Name: azy
Version: 0.0.2
Summary: Turn arbitrary text into a clean URL slug.
Project-URL: Homepage, https://github.com/lqxnjk/azy
Author: lqxnjk
License: MIT
License-File: LICENSE
Keywords: seo,slug,slugify,text,url
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# azy

Turn arbitrary text into a clean, lowercase, ASCII URL slug.

## Install

```console
pip install azy
```

## Usage

```python
from azy import slugify

slugify("Hello, World!")                 # 'hello-world'
slugify("Café au Lait")                  # 'cafe-au-lait'
slugify("  --Already--Slugged--  ")      # 'already-slugged'
slugify("A very long title here", 10)    # 'a-very-lon'
slugify("one two", n_sep="_")            # 'one_two'
```

## Behaviour

| Step | Effect |
| --- | --- |
| NFKD normalize + ASCII encode | `é` → `e`, `ü` → `u` |
| lowercase | `ABC` → `abc` |
| collapse runs of non `[a-z0-9]` | `"a  --  b"` → `a-b` |
| trim separators | no leading or trailing `-` |
| optional truncation | never ends with a separator |

Characters with no ASCII equivalent (CJK, emoji) are dropped. If you need them
kept, transliterate first and slug the result.

## License

MIT
