mirror of
https://github.com/Hopiu/django-uuslug.git
synced 2026-03-16 20:10:24 +00:00
add github action badge
This commit is contained in:
Val Neekman (AvidCoder)
parent
2d820df3a6
commit
c9ed4b5e80
2 changed files with 144 additions and 154 deletions
294
README.md
294
README.md
|
|
@ -1,5 +1,4 @@
|
|||
Django Uuslug
|
||||
====================
|
||||
# Django Uuslug
|
||||
|
||||
**A Django slugify application that guarantees `Uniqueness` and handles `Unicode`**
|
||||
|
||||
|
|
@ -7,13 +6,11 @@ Django Uuslug
|
|||
[![version-image]][version-link]
|
||||
[![coverage-image]][coverage-link]
|
||||
|
||||
Overview
|
||||
========
|
||||
# Overview
|
||||
|
||||
In short: UUSlug == (``U``nique + ``U``nicode) Slug
|
||||
In short: UUSlug == (`U`nique + `U`nicode) Slug
|
||||
|
||||
How to install
|
||||
==================
|
||||
# How to install
|
||||
|
||||
1. easy_install django-uuslug
|
||||
2. pip install django-uuslug
|
||||
|
|
@ -26,221 +23,212 @@ How to install
|
|||
c. run python setup.py
|
||||
5. pip install -e git+https://github.com/un33k/django-uuslug#egg=django-uuslug
|
||||
|
||||
How to use
|
||||
=================
|
||||
# How to use
|
||||
|
||||
```python
|
||||
```python
|
||||
|
||||
####### Unicode Test #######
|
||||
####### Unicode Test #######
|
||||
|
||||
from uuslug import slugify
|
||||
from uuslug import slugify
|
||||
|
||||
txt = "This is a test ---"
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "this-is-a-test")
|
||||
txt = "This is a test ---"
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "this-is-a-test")
|
||||
|
||||
txt = "___This is a test ---"
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "this-is-a-test")
|
||||
txt = "___This is a test ---"
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "this-is-a-test")
|
||||
|
||||
txt = "___This is a test___"
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "this-is-a-test")
|
||||
txt = "___This is a test___"
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "this-is-a-test")
|
||||
|
||||
txt = "This -- is a ## test ---"
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "this-is-a-test")
|
||||
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 = '影師嗎'
|
||||
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 = '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 = '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 = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo-a")
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo-a")
|
||||
|
||||
txt = 'Компьютер'
|
||||
r = slugify(txt)
|
||||
self.assertEqual(r, "kompiuter")
|
||||
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=9)
|
||||
self.assertEqual(r, "jaja-lol")
|
||||
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=15)
|
||||
self.assertEqual(r, "jaja-lol-mememe")
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=15)
|
||||
self.assertEqual(r, "jaja-lol-mememe")
|
||||
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=50)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo-a")
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=50)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo-a")
|
||||
|
||||
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=15, word_boundary=True)
|
||||
self.assertEqual(r, "jaja-lol-a")
|
||||
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=17, word_boundary=True)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo")
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=17, word_boundary=True)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo")
|
||||
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=18, word_boundary=True)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo")
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=18, word_boundary=True)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo")
|
||||
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=19, word_boundary=True)
|
||||
self.assertEqual(r, "jaja-lol-mememeoo-a")
|
||||
txt = 'jaja---lol-méméméoo--a'
|
||||
r = slugify(txt, max_length=19, word_boundary=True)
|
||||
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=".")
|
||||
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=".")
|
||||
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 = '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")
|
||||
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 = 'one two three four five'
|
||||
r = slugify(txt, max_length=13, word_boundary=True, save_order=False)
|
||||
self.assertEqual(r, "one-two-three")
|
||||
txt = 'one two three four five'
|
||||
r = slugify(txt, max_length=13, word_boundary=True, save_order=False)
|
||||
self.assertEqual(r, "one-two-three")
|
||||
|
||||
txt = 'one two three four five'
|
||||
r = slugify(txt, max_length=12, word_boundary=True, save_order=False)
|
||||
self.assertEqual(r, "one-two-four")
|
||||
txt = 'one two three four five'
|
||||
r = slugify(txt, max_length=12, word_boundary=True, save_order=False)
|
||||
self.assertEqual(r, "one-two-four")
|
||||
|
||||
txt = 'one two three four five'
|
||||
r = slugify(txt, max_length=12, word_boundary=True, save_order=True)
|
||||
self.assertEqual(r, "one-two")
|
||||
txt = 'one two three four five'
|
||||
r = slugify(txt, max_length=12, word_boundary=True, save_order=True)
|
||||
self.assertEqual(r, "one-two")
|
||||
|
||||
txt = 'this has a stopword'
|
||||
r = slugify(txt, stopwords=['stopword'])
|
||||
self.assertEqual(r, 'this-has-a')
|
||||
txt = 'this has a stopword'
|
||||
r = slugify(txt, stopwords=['stopword'])
|
||||
self.assertEqual(r, 'this-has-a')
|
||||
|
||||
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'
|
||||
r = slugify(txt, stopwords=['the'])
|
||||
self.assertEqual(r, 'quick-brown-fox-jumps-over-lazy-dog')
|
||||
|
||||
txt = 'Foo A FOO B foo C'
|
||||
r = slugify(txt, stopwords=['foo'])
|
||||
self.assertEqual(r, 'a-b-c')
|
||||
txt = 'Foo A FOO B foo C'
|
||||
r = slugify(txt, stopwords=['foo'])
|
||||
self.assertEqual(r, 'a-b-c')
|
||||
|
||||
txt = 'Foo A FOO B foo C'
|
||||
r = slugify(txt, stopwords=['FOO'])
|
||||
self.assertEqual(r, 'a-b-c')
|
||||
txt = 'Foo A FOO B foo C'
|
||||
r = slugify(txt, stopwords=['FOO'])
|
||||
self.assertEqual(r, 'a-b-c')
|
||||
|
||||
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 = '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')
|
||||
|
||||
|
||||
####### Uniqueness Test #######
|
||||
####### Uniqueness Test #######
|
||||
|
||||
from django.db import models
|
||||
from uuslug import uuslug
|
||||
from django.db import models
|
||||
from uuslug import uuslug
|
||||
|
||||
# Override your object's save method with something like this (models.py)
|
||||
class CoolSlug(models.Model):
|
||||
name = models.CharField(max_length=100)
|
||||
slug = models.CharField(max_length=200)
|
||||
# Override your object's save method with something like this (models.py)
|
||||
class CoolSlug(models.Model):
|
||||
name = models.CharField(max_length=100)
|
||||
slug = models.CharField(max_length=200)
|
||||
|
||||
def __unicode__(self):
|
||||
return self.name
|
||||
def __unicode__(self):
|
||||
return self.name
|
||||
|
||||
def save(self, *args, **kwargs):
|
||||
self.slug = uuslug(self.name, instance=self)
|
||||
super(CoolSlug, self).save(*args, **kwargs)
|
||||
def save(self, *args, **kwargs):
|
||||
self.slug = uuslug(self.name, instance=self)
|
||||
super(CoolSlug, self).save(*args, **kwargs)
|
||||
|
||||
# Note: You can also specify the start number.
|
||||
# Example:
|
||||
self.slug = uuslug(self.name, instance=self, start_no=2)
|
||||
# the second slug should start with "-2" instead of "-1"
|
||||
# Note: You can also specify the start number.
|
||||
# Example:
|
||||
self.slug = uuslug(self.name, instance=self, start_no=2)
|
||||
# the second slug should start with "-2" instead of "-1"
|
||||
|
||||
name = "john"
|
||||
c = CoolSlug.objects.create(name=name)
|
||||
c.save()
|
||||
print(c.slug) # => "john"
|
||||
name = "john"
|
||||
c = CoolSlug.objects.create(name=name)
|
||||
c.save()
|
||||
print(c.slug) # => "john"
|
||||
|
||||
c1 = CoolSlug.objects.create(name=name)
|
||||
c1.save()
|
||||
print(c1.slug) # => "john-1"
|
||||
c1 = CoolSlug.objects.create(name=name)
|
||||
c1.save()
|
||||
print(c1.slug) # => "john-1"
|
||||
|
||||
c2 = CoolSlug.objects.create(name=name)
|
||||
c2.save()
|
||||
print(c2.slug) # => "john-2"
|
||||
c2 = CoolSlug.objects.create(name=name)
|
||||
c2.save()
|
||||
print(c2.slug) # => "john-2"
|
||||
|
||||
|
||||
# If you need truncation of your slug to exact length, here is an example
|
||||
class SmartTruncatedSlug(models.Model):
|
||||
name = models.CharField(max_length=19)
|
||||
slug = models.CharField(max_length=10)
|
||||
# If you need truncation of your slug to exact length, here is an example
|
||||
class SmartTruncatedSlug(models.Model):
|
||||
name = models.CharField(max_length=19)
|
||||
slug = models.CharField(max_length=10)
|
||||
|
||||
def __unicode__(self):
|
||||
return self.name
|
||||
def __unicode__(self):
|
||||
return self.name
|
||||
|
||||
def save(self, *args, **kwargs):
|
||||
self.slug = uuslug(self.name, instance=self, max_length=10)
|
||||
super(SmartTruncatedSlug, self).save(*args, **kwargs)
|
||||
def save(self, *args, **kwargs):
|
||||
self.slug = uuslug(self.name, instance=self, max_length=10)
|
||||
super(SmartTruncatedSlug, self).save(*args, **kwargs)
|
||||
|
||||
# If you need automatic truncation of your slug, here is an example
|
||||
class AutoTruncatedSlug(models.Model):
|
||||
name = models.CharField(max_length=19)
|
||||
slug = models.CharField(max_length=19)
|
||||
# If you need automatic truncation of your slug, here is an example
|
||||
class AutoTruncatedSlug(models.Model):
|
||||
name = models.CharField(max_length=19)
|
||||
slug = models.CharField(max_length=19)
|
||||
|
||||
def __unicode__(self):
|
||||
return self.name
|
||||
def __unicode__(self):
|
||||
return self.name
|
||||
|
||||
def save(self, *args, **kwargs):
|
||||
self.slug = uuslug(self.name, instance=self)
|
||||
super(SmartTruncatedSlug, self).save(*args, **kwargs)
|
||||
```
|
||||
def save(self, *args, **kwargs):
|
||||
self.slug = uuslug(self.name, instance=self)
|
||||
super(SmartTruncatedSlug, self).save(*args, **kwargs)
|
||||
```
|
||||
|
||||
Running the tests
|
||||
=================
|
||||
# Running the tests
|
||||
|
||||
To run the tests against the current environment:
|
||||
|
||||
python manage.py test
|
||||
|
||||
|
||||
License
|
||||
====================
|
||||
# License
|
||||
|
||||
Released under a ([BSD](LICENSE.md)) license.
|
||||
|
||||
# Version
|
||||
|
||||
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.
|
||||
|
||||
[status-image]: https://secure.travis-ci.org/un33k/django-uuslug.png?branch=master
|
||||
[status-link]: http://travis-ci.org/un33k/django-uuslug?branch=master
|
||||
|
||||
[status-image]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml/badge.svg
|
||||
[status-link]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml
|
||||
[status-image]: https://github.com/un33k/django-uuslug/actions/workflows/main.yml/badge.svg
|
||||
[version-image]: https://img.shields.io/pypi/v/django-uuslug.svg
|
||||
[version-link]: https://pypi.python.org/pypi/django-uuslug
|
||||
|
||||
[coverage-image]: https://coveralls.io/repos/un33k/django-uuslug/badge.svg
|
||||
[coverage-link]: https://coveralls.io/r/un33k/django-uuslug
|
||||
|
||||
[download-image]: https://img.shields.io/pypi/dm/django-uuslug.svg
|
||||
[download-link]: https://pypi.python.org/pypi/django-uuslug
|
||||
|
||||
|
||||
Sponsors
|
||||
====================
|
||||
# Sponsors
|
||||
|
||||
[Neekware Inc.](https://github.com/neekware)
|
||||
2
requirements.txt
Normal file
2
requirements.txt
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
Django>=2.2
|
||||
python-slugify>=5.0.1
|
||||
Loading…
Reference in a new issue