Python Slugify

8.0.4 · active · verified Sat Mar 28

Python-slugify is an actively maintained library that generates URL-friendly slugs from strings, with robust Unicode support. It is designed to create clean, human-readable, and SEO-friendly slugs by converting text, handling special characters, and replacing spaces. The library sees regular updates, with an average release cycle of approximately 71 days.

Warnings

gotcha There is a separate, older Python 2-only package also named `slugify` on PyPI. Installing `pip install slugify` will give you the wrong package. Always use `pip install python-slugify` to ensure you get the correct, actively maintained Python 3 library, as both packages use `from slugify import slugify` for import.
Fix: Ensure `pip uninstall slugify` is run if the wrong package was installed, then `pip install python-slugify`. If possible, avoid installing both packages in the same environment.
breaking Python 3.6 support was dropped in version 7.0.0. For the latest versions (8.x.x), the minimum required Python version is 3.10. Older Python versions should use earlier library releases.
Fix: Upgrade your Python interpreter to 3.10 or newer, or pin `python-slugify` to a version compatible with your Python environment (e.g., `<7.0.0` for Python 3.6).
gotcha The optional `Unidecode` dependency (installed via `pip install python-slugify[unidecode]`) is GPL licensed. If your project's license is incompatible with GPL, ensure you do not install this extra. The default `text-unidecode` dependency is permissively licensed.
Fix: If GPL license is a concern, do not install `python-slugify[unidecode]`. The package works with the default `text-unidecode` which is permissively licensed.
breaking The behavior of the `regex_pattern` parameter was inverted in version 6.0.1. It now defines characters to be *disallowed* rather than *allowed*. This changes how custom character filtering works.
Fix: Review and update any custom `regex_pattern` configurations to align with the new 'disallowed characters' logic.

Install

pip install python-slugify Install stable version

Imports

slugify
```
from slugify import slugify
```
A different, outdated Python 2-only package named 'slugify' (installed via `pip install slugify`) uses the same import path. Ensure you installed `python-slugify` to avoid conflicts and Python 3 incompatibility.

Quickstart

The primary `slugify` function is imported and used to convert strings into URL-friendly slugs. It supports various customization options like separators, maximum length, and preserving Unicode characters.

from slugify import slugify

# Basic usage
text = "This is a Test String with Unicode: Lörem Ipsüm!"
slug = slugify(text)
print(f"Basic Slug: {slug}")

# Custom separator
slug_with_underscore = slugify(text, separator='_')
print(f"Slug with underscore: {slug_with_underscore}")

# Max length
short_slug = slugify("A very very long title indeed", max_length=10)
print(f"Short Slug: {short_slug}")

# Keep unicode characters (requires allow_unicode=True)
unicode_slug = slugify("你好世界", allow_unicode=True)
print(f"Unicode Slug: {unicode_slug}")

view raw JSON →