un33k/python-slugify

What are the few gotchas like when migrating from other packages, etc.

un33k opened this issue · 7 comments

un33k commented

Gotchas ...

Migrating form awesome-slugify

  • Entity decoding is fully disabled only if you specify all three options (entities=False, hexadecimal=False, decimal=False) (#79)
un33k commented

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. (#81)
un33k commented

Documentations

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

License

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

Unidecode support for other languages

  • This packages uses text-unidecode or unidecode as its underlying converter. Please raise an issue with those packages instead. (#78)
un33k commented

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.
un33k commented

Pretranslation options

  • To pre-translate some characters, you can use replacements params. (#85)