Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A wagtail module for creating an image field with annotation metadata

Project description

Allows users to combine a Wagtail image with custom annotation data. Annotations are entered on the backend by clicking points on an image, annotation data is then stored with relative x,y coordinates with custom form data.


  • Wagtail >= 1.5
  • Django >= 1.9


Install using pypi

pip install wagtailannotatedimage


Extend the BaseAnnotationForm to define what data should be stored with annotations. AnnotationsField stores the annotations data as a Map with id for the annotation being the key.

from django.db import models
from wagtail.wagtailcore.models import Page
from wagtailannotatedimage.edit_handlers import AnnotatedImagePanel
from wagtailannotatedimage.fields import AnnotationsField
from wagtailannotatedimage.forms import BaseAnnotationForm

class AnnotationForm(BaseAnnotationForm):
    text = forms.CharField(widget=forms.TextInput)

class TestPage(Page):
    image = models.ForeignKey('wagtailimages.Image', blank=True, null=True,
                              on_delete=models.SET_NULL, related_name="+")
    annotations = AnnotationsField(blank=True)

    content_panels = Page.content_panels + [
            'image', 'annotations',
            annotation_form=AnnotationForm(), heading='Annotated Image'

Project details

Release history Release notifications

This version
History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
wagtailannotatedimage-0.0.5.tar.gz (10.7 kB) Copy SHA256 hash SHA256 Source None Nov 6, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page