support for text-unidecode

Author: un33k

.travis.yml

@@ -11,19 +11,19 @@ python:
   - pypy
 
 env:
-  - WITH_TEXTUNIDECODE=yes
-  - WITH_UNIDECODE=yes # this is redundant but otherwise travis will only trigger one build type
+  - SLUGIFY_USES_TEXT_UNIDECODE=yes
+  - SLUGIFY_USES_UNIDECODE=yes # dummy: tell travis to run more than one build types
 
 install:
   - pip install pip -U
-  - if [[ -z "${WITH_TEXTUNIDECODE}" ]]; then pip install -q -r requirements.txt; else pip install -q -r alt_requirements.txt; fi
+  - if [[ -z "${SLUGIFY_USES_TEXT_UNIDECODE}" ]]; then pip install -q -r requirements.txt; else pip install -q -r requirements_alt.txt; fi
   - pip install -e .
-  - pip install pep8
+  - pip install pycodestyle
   - pip install coveralls
   - pip install https://github.com/un33k/pyflakes/tarball/master
 
 before_script:
-  - "bash pep8.sh"
+  - "bash pycodestyle.sh"
   - if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pyflakes -x W slugify; fi
 
 script: coverage run --source=slugify test.py

CHANGELOG.md

@@ -1,7 +1,15 @@
+## 1.2.5
+  - Add support for using text-unidecode (@bolkedebruin)
+  - Switch to pycodestyle instead of pep8
+
 ## 1.2.4
   - Remove build artifacts during packaging
   - Simplify the setup.py file (@reece)
 
+## 1.2.3
+  - Remove build artifacts during packaging
+  - Simplify the setup.py file (@reece)
+
 ## 1.2.3
   - Republish - possible corrupt 1.2.2 build
 

README.rst

@@ -30,7 +30,7 @@ From sources via ``git``:
 
     $ git clone http://github.com/un33k/python-slugify
     $ cd python-slugify
-    $ python setup.py
+    $ python setup.py install
 
 From sources:
 
@@ -39,7 +39,16 @@ From sources:
     $ wget https://github.com/un33k/python-slugify/zipball/master
     # unzip the downloaded file
     # cd into python-slugify-* directory
-    $ python setup.py
+    $ python setup.py install
+
+Note:
+
+By default *python-slugify* installs **unidecode** (GPL) for its decoding needs.
+
+Alternatively *python-slugify* can install and use **text-unidecode** (GPL & Perl Artistic) instead. This is done by setting up
+an environment variable  *SLUGIFY_USES_TEXT_UNIDECODE=yes* prior to installing and/or upgrading `python-slugify`.
+
+In cases where both **unidecode** and **text-unidecode** are installed, *python-slugify* always defaults to using **unidecode** regardless of the *SLUGIFY_USES_TEXT_UNIDECODE=yes* environment variable.
 
 
 How to use
@@ -117,10 +126,6 @@ How to use
     r = slugify(txt, max_length=20, word_boundary=True, separator=".")
     self.assertEqual(r, "jaja.lol.mememeoo.a")
 
-    txt = 'jaja---lol-méméméoo--a'
-    r = slugify(txt, max_length=20, word_boundary=True, separator="ZZZZZZ")
-    self.assertEqual(r, "jajaZZZZZZlolZZZZZZmememeooZZZZZZa")
-
     txt = 'one two three four five'
     r = slugify(txt, max_length=13, word_boundary=True, save_order=True)
     self.assertEqual(r, "one-two-three")
@@ -186,6 +191,11 @@ License
 
 Released under a (`MIT`_) license.
 
+**Note:**
+
+*python-slugify* relies on thirdparty **API** for decoding unicode strings.  This dependency is kept at the public **API** ONLY in
+order to ensure that *python-slugify* never becomes a **derivative work** of any other packages. MIT license holds.
+
 
 Version
 -------
@@ -212,18 +222,3 @@ X.Y.Z Version
 
 .. _MIT: https://github.com/un33k/python-slugify/blob/master/LICENSE
 
-
-GPL
----
-
-By default python-slugify depends on **unidecode** which is released under GPL. In case this is
-a concern to you it is possible to install slugify with **text-unidecode** which is dual licensed
-Perl Artistic and GPL. This can be done by:
-
-.. code:: bash
-    
-    $ export WITH_TEXTUNIDECODE=yes
-
-And then proceed with the normal installation instructions. Please note that this needs to be specified
-for every upgrade. Also be aware that in case **unidecode* is present on the system python-slugify will
-still default to using it.

pep8.sh pycodestyle.sh

@@ -8,4 +8,4 @@
 #  -- E225 missing whitespace around operator
 #  -- E501 line too long
 
-pep8 --ignore=E128,E261,E225,E501 slugify test.py setup.py
+pycodestyle --ignore=E128,E261,E225,E501 slugify test.py setup.py

alt_requirements.txt requirements_alt.txt

@@ -15,7 +15,7 @@
 author = 'Val Neekman'
 author_email = 'info@neekware.com'
 license = 'MIT'
-if "WITH_TEXTUNIDECODE" in os.environ:
+if "SLUGIFY_USES_TEXT_UNIDECODE" in os.environ:
     install_requires = ['text-unidecode>=1.2']
 else:
     install_requires = ['Unidecode>=0.04.16']

setup.py

@@ -3,4 +3,4 @@
 
 __author__ = 'Val Neekman @ Neekware Inc. [@vneekman]'
 __description__ = 'A Python slugify application that also handles Unicode'
-__version__ = '1.2.4'
+__version__ = '1.2.5'

slugify/__init__.py

@@ -112,14 +112,14 @@ def slugify(text, entities=True, decimal=True, hexadecimal=True, max_length=0, w
     if decimal:
         try:
             text = DECIMAL_PATTERN.sub(lambda m: unichr(int(m.group(1))), text)
-        except:
+        except Exception:
             pass
 
     # hexadecimal character reference
     if hexadecimal:
         try:
             text = HEX_PATTERN.sub(lambda m: unichr(int(m.group(1), 16)), text)
-        except:
+        except Exception:
             pass
 
     # translate

slugify/slugify.py

@@ -210,5 +210,6 @@ def test_smart_truncate_no_seperator(self):
         r = smart_truncate(txt, max_length=100, separator='_')
         self.assertEqual(r, txt)
 
+
 if __name__ == '__main__':
     unittest.main()