django-metadata
Attach metadata to any Django models using redis.
Installation
Either check out the package from GitHub or it pull from a release via PyPI:
pip install django-metadata
Usage
With django-metadata you can attach metadata to any Django models, you will be able to link keys and theirs values to any instances.
Currently only Redis is supported with only redis-py as backend.
Let’s say you have this model:
# models.py
from django.db import models
class User(models.Model):
username = models.CharField(max_length=150)Now you have to attach the MetadataMixin to your model:
# models.py
from django.db import models
from metadata.mixins import MetadataMixin
class User(MetadataMixin, models.Model):
username = models.CharField(max_length=150)You can customize the way django-metadata is storing your values by providing a metadata_key property to your model:
# models.py
from django.db import models
from metadata.mixins import MetadataMixin
class User(MetadataMixin, models.Model):
username = models.CharField(max_length=150)
def metadata_key(self):
return 'metadata:utilisateur:%d' % self.pkBy default, the schema will be metadata:%(lowerclassname)s:%(primary_key)s.
Now we have connected our model to the mixin we can play with the API.
The API of MetadataContainer follows the same principes as dict.
Adding keys
>>> from myapp.models import User
>>> user = User.objects.create(username='thoas')
>>> user.metadata['mail_signup_sent'] = 1
>>> user = User.objects.get(username='thoas')
>>> user.metadata['mail_signup_sent']
1
>>> user.metadata = {'mail_signup_sent': 0}
>>> user.metadata['mail_signup_sent']
0Removing keys
You can either removing a key by setting its value to None or use the del operator.
>>> del user.metadata['key']
>>> user.metadata['key']
Traceback (most recent call last):
...
KeyError: 'key'
>>> user.metadata.get('key', None)
None
>>> user.metadata['foo'] = 'bar'
>>> user.metadata['foo'] = None
>>> user.metadata['foo']
Traceback (most recent call last):
...
KeyError: 'foo'
>>> user.metadata.get('foo', None)
None
>>> user.metadata['key'] = 'value'
>>> user.metadata['foo'] = 'bar'
>>> user.metadata = {'foo': None}
>>> user.metadata['foo']
Traceback (most recent call last):
...
KeyError: 'foo'
>>> user.metadata['key']
valueIterating keys
>>> 'value' in user.metadata
True
>>> user.metadata.values()
['value']
>>> user.metadata.keys()
['key']
>>> user.metadata.items()
[('key', 'value')]Incrementing keys
As we are using Redis as storing engine you can use some of its nice features:
>>> user.metadata.incr('counter')
>>> user.metadata['counter']
1
>>> user.metadata.incr('counter', 2)
>>> user.metadata['counter']
3Inspiration
django-metadata comes from an original idea of twidi.
2 maintainers
Metadata
2 maintainers
Release files for django-metadata 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| django-metadata-0.2.0.tar.gz | 7.7 kB | Without provenance | Details |
Release files / django-metadata-0.2.0.tar.gz
| Download URL | django-metadata-0.2.0.tar.gz |
|---|---|
| Size | 7.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b6a886a6bf6af623c39aa97e80c28dd5aa0d73f7cd08bfb301a684e1cc100695
|
|
BLAKE2b-256 checksum How to use checksums |
262233d415beb1dea307aadb6f91fd0f175db5e118f98ed1acfce01b8d846b1d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django-metadata 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
