awesome-slugify
Python flexible slugify function
Install
pip install awesome-slugify
Usage
from slugify import slugify
slugify('Any text') # 'Any-text'
Custom slugify
from slugify import slugify, Slugify, UniqueSlugify
slugify('Any text', to_lower=True) # 'any-text'
custom_slugify = Slugify(to_lower=True)
custom_slugify('Any text') # 'any-text'
custom_slugify.separator = '_'
custom_slugify('Any text') # 'any_text'
custom_slugify = UniqueSlugify()
custom_slugify('Any text') # 'any-text'
custom_slugify('Any text') # 'any-text-1'
slugify function optional args
to_lower # if True convert text to lowercase
max_length # output string max length
separator # separator string
capitalize # if True upper first letter
Slugify class args
pretranslate = None # function or dict for replace before translation
translate = unidecode.unidecode # function for slugifying or None
safe_chars = '' # additional safe chars
stop_words = () # remove these words from slug
to_lower = False # default to_lower value
max_length = None # default max_length value
separator = '-' # default separator value
capitalize = False # default capitalize value
UniqueSlugify class args
# all Slugify class args +
uids = [] # initial unique ids
Predefined slugify functions
Some slugify functions is predefined this way:
from slugify import Slugify, CYRILLIC, GERMAN, GREEK
slugify = Slugify()
slugify_unicode = Slugify(translate=None)
slugify_url = Slugify()
slugify_url.to_lower = True
slugify_url.stop_words = ('a', 'an', 'the')
slugify_url.max_length = 200
slugify_filename = Slugify()
slugify_filename.separator = '_'
slugify_filename.safe_chars = '-.'
slugify_filename.max_length = 255
slugify_ru = Slugify(pretranslate=CYRILLIC)
slugify_de = Slugify(pretranslate=GERMAN)
slugify_el = Slugify(pretranslate=GREEK)
Examples
from slugify import Slugify, UniqueSlugify, slugify, slugify_unicode
from slugify import slugify_url, slugify_filename
from slugify import slugify_ru, slugify_de
slugify('one kožušček') # one-kozuscek
slugify('one two three', separator='.') # one.two.three
slugify('one two three four', max_length=12) # one-two-four (12 chars)
slugify('one TWO', to_lower=True) # one-two
slugify('one TWO', capitalize=True) # One-TWO
slugify_filename(u'Дrаft №2.txt') # Draft_2.txt
slugify_url(u'Дrаft №2.txt') # draft-2-txt
my_slugify = Slugify()
my_slugify.separator = '.'
my_slugify.pretranslate = {'я': 'i', '♥': 'love'}
my_slugify('Я ♥ борщ') # I.love.borshch (custom translate)
slugify('Я ♥ борщ') # Ia-borshch (standard translation)
slugify_ru('Я ♥ борщ') # Ya-borsch (alternative russian translation)
slugify_unicode('Я ♥ борщ') # Я-борщ (sanitize only)
slugify_de('ÜBER Über slugify') # UEBER-Ueber-slugify
slugify_unique = UniqueSlugify(separator='_')
slugify_unique('one TWO') # One_TWO
slugify_unique('one TWO') # One_TWO_1
slugify_unique = UniqueSlugify(uids=['cellar-door'])
slugify_unique('cellar door') # cellar-door-1
Custom Unique Slugify Checker
from slugify import UniqueSlugify
def my_unique_check(text, uids):
if text in uids:
return False
return not SomeDBClass.objects.filter(slug_field=text).exists()
custom_slugify_unique = UniqueSlugify(unique_check=my_unique_check)
# Checks the database for a matching document
custom_slugify_unique('te occidere possunt')
Running UnitTests
$ virtualenv venv
$ venv/bin/pip install -r requirements.txt
$ venv/bin/nosetests slugify
1 Oct 20, 2021
59 Oct 10, 2022
117 Dec 29, 2022
8 Sep 18, 2021
11 Jan 05, 2023
2 Oct 12, 2021
47 Sep 05, 2022
3 Oct 09, 2021
111 Dec 19, 2022
16 Sep 15, 2022
2 Nov 03, 2022
1 Feb 20, 2022
3 Jan 29, 2022
2 Feb 05, 2022
1 Nov 17, 2021
1 Nov 09, 2021
2 Feb 12, 2022
9 Jan 07, 2023
3.1k Dec 29, 2022
18 Dec 19, 2022