https://github.com/Racum/django-binhash
Work with hexadecimal, store in binary, using half of the data size.
https://github.com/Racum/django-binhash
binary-data data-structures django django-orm fieldtype hash
Last synced: 7 months ago
JSON representation
Work with hexadecimal, store in binary, using half of the data size.
- Host: GitHub
- URL: https://github.com/Racum/django-binhash
- Owner: Racum
- License: other
- Created: 2017-08-14T14:55:21.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-09T12:31:07.000Z (over 1 year ago)
- Last Synced: 2024-07-25T04:33:44.975Z (about 1 year ago)
- Topics: binary-data, data-structures, django, django-orm, fieldtype, hash
- Language: Python
- Size: 13.7 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Binary Hash Fields
Work with hexadecimal, store in binary, using half of the data size.
## Installation
Just install via `pip`:
```
pip install django-binhash
```
And add to your apps on `settings.py`:
```python
INSTALLED_APPS = [
# Django apps
'binhash',
# Your apps
]
```
## Compatibility
### Environments
Tested under Python from 3.10 to 3.12, and under Django 4.x and 5.x.
### Databases
At the version `0.2.0` it was only tested on SQLite, but if should work fine in all databases officially supported by Django.
### Formats
* MD5
* `MD5Field`
* SHA-1
* `SHA1Field`
* SHA-2
* `SHA224Field`
* `SHA256Field`
* `SHA384Field`
* `SHA512Field`
* SHA-3
* `SHA3_224Field`
* `SHA3_256Field`
* `SHA3_384Field`
* `SHA3_512Field`
* `SHAKE128Field`
* `SHAKE256Field`
* `SHAKE512Field`
## Usage
Just import and set some fields:
```python
from django.db import models
from binhash import (MD5Field, SHA1Field, SHA256Field)
class ISOFile(models.Model):
name = models.CharField('Name', max_length=30)
url = models.URLField('URL')
md5sum = MD5Field('MD5 Checksum')
sha1sum = SHA1Field('SHA-1 Checksum')
sha256sum = SHA256Field('SHA-256 Checksum')
```
Than, proceed using them like CharFields:
```python
# Create normaly as if the fields were strings:
ISOFile.objects.create(
name='Ubuntu Server 17.04',
md5sum='d02df11b4a7318b7250824f6d0bab9c0',
sha1sum='bc5fb639724b5cd90eb739845f246e2c564b0dd8',
sha256sum='632e64dde9a7da27fa96bea4d2cf78f051065c6becc0d0f728aabfc091396256',
)
# Fetch by string is also supported:
ubuntu = ISOFile.objects.get(md5sum='d02df11b4a7318b7250824f6d0bab9c0')
# Everything works as expected on the application side:
print(ubuntu.sha1sum) # Shows bc5fb639724b5cd90eb739845f246e2c564b0dd8
print(type(ubuntu.sha1sum)) # Shows
```
If you are feeling skeptical, check the database:
```
$ ./manage.py dbshell
sqlite> .header on
sqlite> .mode column
sqlite> select hex(sha1sum) hex_sha1,
...> length(hex(sha1sum)) size_if_this_was_varchar,
...> length(sha1sum) actual_size
...> from downloads_isofile;
hex_sha1 size_if_this_was_varchar actual_size
---------------------------------------- ------------------------ -----------
BC5FB639724B5CD90EB739845F246E2C564B0DD8 40 20
```
## License
This library is released under the **3-Clause BSD License**.
**tl;dr**: *"free to use as long as you credit me"*.