Django model field metadata and utilities
Project description
django-model-field-meta
An easy-to-use plugin to allow optional metadata of model fields.
Compatible with django-model-utils
, safedelete
, etc.
Tested on Python 3+, Django 2.1+.
Example
Inserting metadata:
from model_field_meta import models, FieldMetaMixin
class MyModel(FieldMetaMixin, models.Model):
my_field = models.TextField(meta={"key": "value"})
Accessing metadata:
model_obj = MyModel.objects.first()
model_obj.get_field_meta("my_field")
# {"key": "value"}
Or,
MyModel.get_field_meta("my_field")
# {"key": "value"}
Installation
Install from PiPy:
pip install django-model-field-meta
or, if you are using Pipenv:
pipenv install django-model-field-meta
Why metadata in model field?
In one of my Django projects, I needed to supply extra information about our model fields.
For my purpose, help_text
is too limited. Using code comments is not feasible as I need to use those information programatically.
Hence, django_model_field_meta
package is created.
Compatibility with third-party packages
In my project, I use:
django-model-utils
for itsInheritanceManager
.safedelete
for itsSafeDeleteModel
So far, I haven't encounter any issue. Feel free to report if you do.
Issues
If you have questions or issues using it, please create a Github issue at:
Project details
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-model-field-meta-0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cef8c8ce1c0361dc989b3f675c5f2736e0aa5c132d5b744164fac8f1b4b1b080 |
|
MD5 | 692f35f9fe0fa22de156cc24a2b48942 |
|
BLAKE2b-256 | 9a048359bf67ee10d3ed50aff835674e729e7290dcf3ed722011153fa6672253 |
Hashes for django_model_field_meta-0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2358176054e7391b1d1fc0f22591e37df6a6fc7231ac670410e885bfec2015f9 |
|
MD5 | eaec190f31e565904c350790d3470701 |
|
BLAKE2b-256 | a73433293af726058629c54e43c6791d0133a72fa68fbb7430c8b7c47e3e14f4 |