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', )
Enjoy!
Settings
ADMIN_AUTO_EXTRACT_UUID_SEARCH_FIELDS
: defaultTrue
- This setting is to auto fill
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 auto fill
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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 465e9203b3e77bc650c904d7e574fa2d58ec9fd94503c0eee72b5369226cfa16 |
|
MD5 | e00af40bbba612c628a3d7e47f98ef07 |
|
BLAKE2b-256 | 88d7bc081620c74f68692787525b5f5ee29e7a39a2dd38be68b5c2a1cdd954a5 |
Hashes for django_nativeshortuuidfield-1.3.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34fbb6b258ed21f1768d23d5d6526da1de93167f0e98900acecd80a09cc82516 |
|
MD5 | 07900edfba2f5f08ac4b5ee139c63fd3 |
|
BLAKE2b-256 | fc63cd6439af767258d00a5115bbb78fb78fb33e2272ef864a73f037b2efded4 |