A decoder/encoder Field for uuid
Project description
django-nativeshortuuidfield
Provides a NativeShortUUIDField for your Django models which uses the base-57 "Short UUID" package at https://github.com/stochastic-technologies/shortuuid/ to be used in Python and store it as full UUID in database.
Installation
Install it with pip (or easy_install):
$ pip install django-nativeshortuuidfield
Usage
First you'll need to add a NativeShortUUIDField to your class:
from native_shortuuid import NativeShortUUIDField
class MyModel(models.Model):
uuid = NativeShortUUIDField(unique=True, default=uuid.uuid4)
If you want to add the ability to search by shortuuid in ModelAdmin
you need to inherit NativeUUIDSearchMixin
from native_shortuuid.admin import NativeUUIDSearchMixin
@admin.register(models.MyModel)
class MyModelAdmin(NativeUUIDSearchMixin, admin.ModelAdmin):
search_fields = ('uuid', )
If you want to have to ability to write your own uuid search fields list
from native_shortuuid.admin import NativeUUIDSearchMixin
@admin.register(models.MyModel)
class MyModelAdmin(NativeUUIDSearchMixin, admin.ModelAdmin):
admin_auto_extract_uuid_search_fields = False
search_fields = ('name', )
search_uuid_fields = ['uuid', 'foreign_model__uuid']
Enjoy!
Settings
ADMIN_AUTO_EXTRACT_UUID_SEARCH_FIELDS
: defaultTrue
- This setting is to autofill
search_uuid_fields
in the ModelAdmins that inheritsNativeUUIDSearchMixin
with all shortuuid fields that are in thesearch_fields
array. if you turned it off, you'll need to definesearch_uuid_fields
on you ModelAdmin in order to search on shortuuid fields
- This setting is to autofill
Notes
-
NativeShortUUIDField is a subclass of django.db.models.UUIDField
-
You can pass usual Django UUIDField parameters on init, although some of them are added/overwritten:
- blank=True, editable=False (set auto=False to remove these fields enforcement)
Contribution Notes
Pull Request
- Increase the version number in the
setup.py
to the new version that the new pull request represents.
Publishing the Package
After the pull request gets merged into the master branch a new release should be created
-
Create a new tag with the same version number you updated the
setup.py
with:$ git checkout master $ git tag -a 2.1.0 -m 'fix importing order' $ git push origin 2.1.0
-
Go to GitHub's releases section and create a new release:
- Chose the tag version that you just created
- Fill the release title with the same version number
- Add a description of the release and publish it
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-nativeshortuuidfield-1.3.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa6815542edd6a8158cdccb2a3d542aba88582cbec64016209705cad9d843e24 |
|
MD5 | a9c828435a39bf8511a687ed0c3a3778 |
|
BLAKE2b-256 | 50c2b1a6a70fc400c3e9a016d42646cb9bb18469b9f51d08fc642b5a99878195 |
Hashes for django_nativeshortuuidfield-1.3.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2512a73f77403aa0be84b392827269222e9a83491ed9399375ad2926c2f4aab |
|
MD5 | 7fe6e11b84791fbcd7c6b11164c313ff |
|
BLAKE2b-256 | b429a231b13625e238245ac0eae0f1343ac86d5b99eaaa36737cd8fa91914ba5 |