hhy5277 / python-slugify

Returns unicode slugs

Python Slugify

A Python slugify application that handles unicode.

Overview

Best attempt to create slugs from unicode strings while keeping it DRY.

Notice

By default, this modules installs and uses Unidecode (GPL) for its decoding needs. However if you wish to use text-unidecode (GPL & Perl Artistic) instead, please ensure it is installed prior to python-slugify installation.

In cases where both Unidecode and text-unidecode are installed, Unidecode is used as the default decoding module.

How to install

1. easy_install python-slugify
2. pip install python-slugify
3. git clone http://github.com/un33k/python-slugify
    a. cd python-slugify
    b. python setup.py install
4. wget https://github.com/un33k/python-slugify/zipball/master
    a. unzip the downloaded file
    b. cd python-slugify-*
    c. python setup.py install

How to use

 from slugify import slugify

 txt = "This is a test ---"
 r = slugify(txt)
 self.assertEqual(r, "this-is-a-test")

 txt = '影師嗎'
 r = slugify(txt)
 self.assertEqual(r, "ying-shi-ma")

 txt = 'C\'est déjà l\'été.'
 r = slugify(txt)
 self.assertEqual(r, "c-est-deja-l-ete")

 txt = 'Nín hǎo. Wǒ shì zhōng guó rén'
 r = slugify(txt)
 self.assertEqual(r, "nin-hao-wo-shi-zhong-guo-ren")

 txt = 'Компьютер'
 r = slugify(txt)
 self.assertEqual(r, "kompiuter")

 txt = 'jaja---lol-méméméoo--a'
 r = slugify(txt, max_length=9)
 self.assertEqual(r, "jaja-lol")

 txt = 'jaja---lol-méméméoo--a'
 r = slugify(txt, max_length=15, word_boundary=True)
 self.assertEqual(r, "jaja-lol-a")

 txt = 'jaja---lol-méméméoo--a'
 r = slugify(txt, max_length=20, word_boundary=True, separator=".")
 self.assertEqual(r, "jaja.lol.mememeoo.a")

 txt = 'one two three four five'
 r = slugify(txt, max_length=13, word_boundary=True, save_order=True)
 self.assertEqual(r, "one-two-three")

 txt = 'the quick brown fox jumps over the lazy dog'
 r = slugify(txt, stopwords=['the'])
 self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog')

 txt = 'the quick brown fox jumps over the lazy dog in a hurry'
 r = slugify(txt, stopwords=['the', 'in', 'a', 'hurry'])
 self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog')

 txt = 'thIs Has a stopword Stopword'
 r = slugify(txt, stopwords=['Stopword'], lowercase=False)
 self.assertEqual(r, 'thIs-Has-a-stopword')

 txt = "___This is a test___"
 regex_pattern = r'[^-a-z0-9_]+'
 r = slugify(txt, regex_pattern=regex_pattern)
 self.assertEqual(r, "___this-is-a-test___")

 txt = "___This is a test___"
 regex_pattern = r'[^-a-z0-9_]+'
 r = slugify(txt, separator='_', regex_pattern=regex_pattern)
 self.assertNotEqual(r, "_this_is_a_test_")

 txt = '10 | 20 %'
 r = slugify(txt, replacements=[['|', 'or'], ['%', 'percent']])
 self.assertEqual(r, "10-or-20-percent")

For more examples, have a look at the test.py file.

Running the tests

To run the tests against the current environment:

python test.py

License

Released under a (MIT) license.

Version

X.Y.Z Version

`MAJOR` version -- when you make incompatible API changes,
`MINOR` version -- when you add functionality in a backwards-compatible manner, and
`PATCH` version -- when you make backwards-compatible bug fixes.

Sponsors