UNKNOWN
Project description
djcroco adds custom field in your Django models to add support for the Crocodoc API.
Installation
To install djcroco, simply run:
pip install djcroco
Define Crocodoc API token.
In settings.py:
CROCO_API_TOKEN = '<api_token>'
Or alternatively in env.sh:
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. See docs for more details.
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.
{{ obj.document.type }}
Returns type (extension) of the file.
{{ obj.document.uuid }}
Returns UUID of the file (each document has unique id).
{{ obj.document.thumbnail }}
Returns thumbnail as inline image (see Data URI scheme for more details).
{{ obj.document.view_file }}
Returns url of the file so document can be viewed directly.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.