slugany

Multi-language slugify with zero dependencies. A simple, MIT-licensed alternative to python-slugify.

Features

• Zero deps — no GPL, no text-unidecode, no UnicodeData beyond the stdlib
• Multi-language — built-in tables for Spanish, Portuguese, German, French, and Italian
• Smart punctuation — normalizes curly quotes, em-dashes, NBSP, zero-width characters, bullets
• Case styles — kebab, snake, camel, pascal, dot, train, filename
• CLI included — slugany "text" from the terminal with auto-stdin
• lru_cache — results cached automatically (maxsize=512)
• Idempotent — slugify(slugify(x)) == slugify(x) guaranteed
• Fully typed — type hints on every public API, py.typed marker included
• ~550 lines core — auditable, no bloat

Installation

pip install slugany

Requires Python 3.11 or later. No runtime dependencies.

Quickstart

from slugany import slugify

slugify("¡Hola Mundo!")        # "hola-mundo"
slugify("Café résumé naïve")   # "cafe-resume-naive"
slugify("Ñandú coração")       # "nandu-coracao"
slugify("Über Straße", lang="de")  # "ueber-strasse"

CLI

slugany "Hello World"
# hello-world

echo "Café" | slugany
# cafe

slugany "hello world" --style camel
# helloWorld

slugany "hello-world-foo" --max-length 10 --word-boundary
# hello-world

Styles

slugify("hello world", style="kebab")    # "hello-world"
slugify("hello world", style="snake")    # "hello_world"
slugify("hello world", style="camel")    # "helloWorld"
slugify("hello world", style="pascal")   # "HelloWorld"
slugify("hello world", style="dot")      # "hello.world"
slugify("hello world", style="train")    # "Hello-World"
slugify("Hello World", style="filename") # "Hello-World"

Languages

slugify("España", lang="es")             # "espana"
slugify("Coração", lang="pt")            # "coracao"
slugify("Über Straße", lang="de")        # "ueber-strasse"
slugify("Cœur", lang="fr")               # "coeur"
slugify("Caffè", lang="it")              # "caffe"

Advanced

# Stopwords
slugify("the quick brown fox", stopwords=["the", "fox"])  # "quick-brown"

# Custom replacements
slugify("hello world", replacements={"hello": "hi"})  # "hi-world"

# Emoji handling
slugify("Hello \U0001f389 World", emoji_mode="strip")  # "hello-world"
slugify("Hello \U0001f389 World", emoji_mode="keep")   # "hello-world"

# CSS-safe (prefix digit-leading slugs)
slugify("123 main st", css_safe=True)  # "s-123-main-st"

# Fallback for empty results
slugify("!!!", fallback="untitled")  # "untitled"

# Unicode preservation
slugify("\u00d1and\u00fa", allow_unicode=True)  # "\u00f1and\u00fa"

# Batch processing
from slugany import slugify_batch
slugify_batch(["Hello World", "Caf\u00e9 R\u00e9sum\u00e9"])  # ["hello-world", "cafe-resume"]

# Validation
from slugany import is_slug
is_slug("hello-world")   # True
is_slug("hello world")   # False
is_slug("hello_world", separator="_")  # True

Migration from python-slugify

slugany is designed as a drop-in replacement with keyword-only arguments:

# python-slugify
from slugify import slugify
slugify("Hello World", "_")

# slugany
from slugany import slugify
slugify("Hello World", separator="_")

See the migration guide for full details.

Why slugany?

Documentation

Full documentation is available at mathiaspaulenko.github.io/slugany.

• Basic usage
• Styles & presets
• Languages
• CLI reference
• API reference
• Contracts & guarantees

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

Please read our Code of Conduct before participating in the community.

License

MIT — see LICENSE.