djcroco 0.2.2

Installation

To install djcroco, simply run:

pip install djcroco

Include in urls.py:

url(r'', include('djcroco.urls')),

Define Crocodoc API token in settings.py:

CROCO_API_TOKEN = '<api_token>'

Or alternatively as env variable:

export CROCO_API_TOKEN='<api_token>'

Usage

Define the field in model you wish to extend:

from django.db import models

from djcroco.fields import CrocoField


class Example(models.Model):
    name = models.CharField(max_length=255)
    document = CrocoField()

    def __unicode__(self):
        return self.name

Custom thumbnails size

You can pass thumbnail_size like so:

document = CrocoField(thumbnail_size=(150, 150))

Where tuple is represented as (width, height).

If you do not pass custom thumbnail size, the default will be used (100x100). The maximum dimensions for thumbnail is 300x300.

Render the awesomeness

{{ obj.document.name }}

Returns name of the file.

{{ obj.document.size }}

Returns size of the file (in bytes).

{{ obj.document.size_human }}

Returns human-readable size of the file (eg. 1.3 MB).

{{ obj.document.type }}

Returns type (extension) of the file.

{{ obj.document.uuid }}

Returns UUID of the file (each Crocodoc document has unique id).

{{ obj.document.thumbnail }}

Returns thumbnail as inline image (see Data URI scheme for more details).

{{ obj.document.url }}

Returns url of the file so document can be viewed directly.

{{ obj.document.content_url }}

Returns url of the file wrapped in HttpResponse object.

{{ obj.document.download_document }}

Downloads the original document in PDF.

Dependencies

djcroco depends only on crocodoc-python in order to communicate with Crocodoc API service.

Limitations

djcroco was tested on Django 1.4/Python 2.7.3. Other versions of Django/Python will be supported soon.