-
Notifications
You must be signed in to change notification settings - Fork 108
Home
Val Neekman edited this page Oct 20, 2019
·
3 revisions
There are few gotchas that may be good to know about, especially when migrating from other packages, etc
- Entity decoding is fully disabled only if you specify all three options (entities=False, hexadecimal=False, decimal=False) (https://github.com/un33k/python-slugify/issues/79)
- In some IDEs (e.g. Pycharm),
from slugify import slugify
might automatically install the missing package for you. In this example, a package calledslugify
will be instead. To you this package you need to installpython-slugify
yourself. (https://github.com/un33k/python-slugify/issues/81)
- If you want to see a list of options you can pass into
slugify()
, you can refer to the readme file. (Parameters & Options)
- This package is under the MIT license. This package by default installs
text-unidecode
. But you can instead useunidecode
. (Install Options)
- This packages uses
text-unidecode
orunidecode
as its underlying converter. Please raise an issue with those packages instead. (https://github.com/un33k/python-slugify/issues/78)
- This package is called
python-slugify
and it keeps its version within the package itself and not in the name. If you seepython-slugify2
orpython-slugify3
etc, they are unauthorized clones. Please make sure you and your IDE installpython-slugify
in order to get the latest updates.
- To pre-translate some characters, you can use
replacements
params. (https://github.com/un33k/python-slugify/issues/85)
- Please make sure you raise your PR against the
staging
branch as changelog and versioning must be sorted out prior to merge into master.