Skip to main content

django-exiffield extracts exif information by utilizing exiftool.

Project description

https://img.shields.io/pypi/v/django-exiffield.svg Build Status Coverage https://img.shields.io/pypi/pyversions/django-exiffield.svg https://img.shields.io/pypi/status/django-exiffield.svg https://img.shields.io/pypi/l/django-exiffield.svg

django-exiffield extracts exif information by utilizing exiftool.

Requirements

Installation

  1. Install django-exiffield

    pip install django-exiffield
  2. Make sure exiftool is executable from you environment.

Integration

Let’s assume we have an image Model with a single ImageField. To extract exif information for an attached image, add an ExifField, specify the name of the ImageField in the source argument

from django.db import models

from exiffield.fields import ExifField


class Image(models.Model):
    image = models.ImageField()
    exif = ExifField(
        source='image',
    )

and create a migration for the new field. That’s it.

After attaching an image to your ImageField, the exif information is stored as a dict on the ExifField. Each exif information of the dictionary consists of two keys:

  • desc: A human readable description

  • val: The value for the entry.

In the following example we access the camera model

image = Image.objects.get(...)
print(image.exif['Model'])
# {
#     'desc': 'Camera Model Name',
#     'val': 'DMC-GX7',
# }

As the exif information is encoded in a simple dict you can iterate and access the values with all familiar dictionary methods.

Denormalizing Fields

Since the ExifField stores its data simply as text, it is not possible to filter or access indiviual values efficiently. The ExifField provides a convinient way to denormalize certain values using the denormalized_fields argument. It takes a dictionary with the target field as key and a simple getter function of type Callable[[Dict[Dict[str, str]]], Any]. To denormalize a simple value you can use the provided exiffield.getters.exifgetter

from django.db import models

from exiffield.fields import ExifField
from exiffield.getters import exifgetter


class Image(models.Model):
    image = models.ImageField()
    camera = models.CharField(
        editable=False,
        max_length=100,
    )
    exif = ExifField(
        source='image',
        denormalized_fields={
            'camera': exifgetter('Model'),
        },
    )

There are more predefined getters in exiffield.getters:

exifgetter(exif_key: str) -> str

Get an unmodified exif value.

get_type() -> str

Get file type, e.g. video or image

get_datetake -> Optional[datetime]

Get when the file was created as datetime

get_orientation -> exiffield.getters.Orientation

Get orientation of media file. Possible values are LANDSCAPE and PORTRAIT.

get_sequenctype -> exiffield.getters.Mode

Guess if the image was taken in a sequence. Possible values are BURST, BRACKETING, TIMELAPSE and SINGLE.

get_sequencenumber -> int

Get image position in a sequence.

Development

This project is using poetry to manage all dev dependencies. Clone this repository and run

poetry develop

to create a virtual enviroment with all dependencies. You can now run the test suite using

poetry run pytest

This repository follows the angular commit conventions. You can register a pre-commit hook to validate your commit messages by using husky. The configurations are already in place if you have nodejs installed. Just run

npm install

and the pre-commit hook will be registered.

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

django-exiffield-1.0.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

django_exiffield-1.0.0-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file django-exiffield-1.0.0.tar.gz.

File metadata

  • Download URL: django-exiffield-1.0.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.11.2 CPython/3.6.6 Linux/4.17.6-1-ARCH

File hashes

Hashes for django-exiffield-1.0.0.tar.gz
Algorithm Hash digest
SHA256 22b952b6392f177e6550886131ec77d3d100e8a1411c5967fa18b28f6ff9d42c
MD5 7141f94fc0c063031339117c0f3633a1
BLAKE2b-256 dd1fd7caf02d72ba17e58280cf142581e1e0959cbc6f94a29aca02355a997e01

See more details on using hashes here.

File details

Details for the file django_exiffield-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: django_exiffield-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.11.2 CPython/3.6.6 Linux/4.17.6-1-ARCH

File hashes

Hashes for django_exiffield-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d912ff02610236dcfadad7e396995ce6761fa7a545b02d61d0b926b59a0ec012
MD5 8df936c7f3688d3580f37d0218df73b0
BLAKE2b-256 e8e337f7dd3318b157b59d1841cb9118671a5839c66b3765e5c80877c9ad9bff

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page