awesome-slugify: A Flexible Python Slugify Function

Introduction

awesome-slugify is a highly flexible Python library designed for converting text into clean, URL-friendly slugs. It provides robust functionality to transform various text inputs into consistent formats, handling special characters, spaces, and case sensitivity with ease. This library is ideal for generating slugs for URLs, filenames, or any other context requiring sanitized string representations.

Installation

Installing awesome-slugify is straightforward using pip:

pip install awesome-slugify

Examples

Here are some examples demonstrating the versatility of awesome-slugify:

from slugify import slugify, Slugify, UniqueSlugify
from slugify import slugify_url, slugify_filename
from slugify import slugify_ru, slugify_de

# Basic usage
slugify('Any text')  # 'Any-text'

# Customization
slugify('Any text', to_lower=True)  # 'any-text'

# Using Slugify class for persistent options
custom_slugify = Slugify(to_lower=True)
custom_slugify('Any text')          # 'any-text'
custom_slugify.separator = '_'
custom_slugify('Any text')          # 'any_text'

# Generating unique slugs
unique_slug_gen = UniqueSlugify()
unique_slug_gen('Any text')          # 'any-text'
unique_slug_gen('Any text')          # 'any-text-1'

# Predefined slugify functions
slugify_filename('?r?ft ?2.txt')     # Draft_2.txt
slugify_url('?r?ft ?2.txt')          # draft-2-txt

# Custom pretranslation
my_slugify = Slugify()
my_slugify.separator = '.'
my_slugify.pretranslate = {'?': 'i', '?': 'love'}
my_slugify('? ? ????')                # I.love.borshch

# Language-specific slugification
slugify_ru('? ? ????')                # Ya-borsch
slugify_de('ÜBER Über slugify')       # UEBER-Ueber-slugify

Why Use It

awesome-slugify stands out due to its extensive customization options and powerful features:

• Flexibility: Offers fine-grained control over slug generation with parameters like to_lower, max_length, separator, capitalize, pretranslate, safe_chars, and stop_words.
• Unique Slug Generation: The UniqueSlugify class ensures that generated slugs are unique, which is crucial for database entries or file systems.
• Predefined Configurations: Comes with ready-to-use slugifiers for common scenarios, such as slugify_url and slugify_filename, and supports various languages like Russian, German, and Greek.
• Custom Unique Checker: Allows integration with external systems, such as databases, to verify slug uniqueness.
• Easy Integration: Simple API makes it easy to incorporate into any Python project.

Links

• GitHub Repository: https://github.com/voronind/awesome-slugify
• PyPI Package: https://pypi.python.org/pypi/awesome-slugify