Home

Welcome to the python-slugify wiki!

There are few gotchas that may be good to know about, especially when migrating from other packages, etc

Migrating form awesome-slugify

• 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)

If you are using IDEs like PyCharm

• In some IDEs (e.g. Pycharm), from slugify import slugify might automatically install the missing package for you. In this example, a package called slugify will be instead. To you this package you need to install python-slugify yourself. (https://github.com/un33k/python-slugify/issues/81)

Documentations

• If you want to see a list of options you can pass into slugify(), you can refer to the readme file. (Parameters & Options)

License

• This package is under the MIT license. This package by default installs text-unidecode. But you can instead use unidecode. (Install Options)

Unidecode support for other languages

• This packages uses text-unidecode or unidecode as its underlying converter. Please raise an issue with those packages instead. (https://github.com/un33k/python-slugify/issues/78)

Versioning

• This package is called python-slugify and it keeps its version within the package itself and not in the name. If you see python-slugify2 or python-slugify3 etc, they are unauthorized clones. Please make sure you and your IDE install python-slugify in order to get the latest updates.

Pretranslation options

• To pre-translate some characters, you can use replacements params. (https://github.com/un33k/python-slugify/issues/85)

Contribution

• Please make sure you raise your PR against the staging branch as changelog and versioning must be sorted out prior to merge into master.