django_turnit 0.1.4a1

PDF thumbnailer and viewer for django applications

django_turnit provides a way to display PDF files in a turn.js player.

Requirements

• The Ghostscript application / library. It cn be installed as a package in linux distributions, such an in debian / ubuntu :

$ sudo apt install ghostscript  # on debian
$ sudo apt-get install ghostscript  # on ubuntu

Installation

$ pip install django-turnit

This installs the packages that are required by django_turnit:

• python-ghostscript: C python binding for the Ghostscript library

• django-appconf : Helper for configuration of applications

$ python manage.py migrate django_turnit  # Creates the table needed for caching the names of the page images

Usage

django_turnit can create and manage page images for PDF files. This images are stored in the media folder, a database stores .

Management command

The turnit command creates the missing thumbnails for each FileField containing a PDF file.

$ ./manage.py turnit <app_label>[.<model_name>[.<pk>[.<field_name>]]] [arg]

Where:

• <app_label> is the application label. If set, the whole application is scanned for PDF files, and they are thumbnailed.

• <model_name> is the madel name. If set, the model is scanned.

• <pk> is the row pk. If set, the row is scanned

• <field_name> field name.

Signals processing

Settings

TURNIT_INPUT_SUPPORTED_FILE_TYPES

Supported file MIME types.

TURNIT_INPUT_SUPPORTED_FILE_TYPES = ['application/pdf', ]

TURNIT_OUTPUT_MEDIA_ROOT

Name of the sub-folder created under the MEDIA_ROOT folder, to store the output image files.

TURNIT_OUTPUT_MEDIA_ROOT = 'django_turnit'

TURNIT_OUTPUT_FILE_FMT

Ghostscript output file name format.

TURNIT_OUTPUT_FILE_FMT = '%(basename)s.%(i)03d.%(ext)s'

TURNIT_OUTPUT_IMAGE_FORMAT

Ghostscript output file format, as defined in Ghostscript documentation.

You can choose between:

• PNG

  • png16m: 24 bit color PNG (default value)

  • pnggray: 8 bit gray scale PNG

  • png256: 256 colors PNG

  • png16: 16 colors PNG

  • pngmonod: Black and white monochrome PNG

• JPEG

  • jpeg: jpeg standart output

• TIFF

  • tiffgray: 8-bit gray output.

  • tiff12nc: 12-bit RGB output (4 bits per component).

  • tiff24nc: 24-bit RGB output (8 bits per component).

  • tiff48nc: 48-bit RGB output (16 bits per component).

  • tiff32nc: 32-bit CMYK output (8 bits per component).

  • tiff64nc: 64-bit CMYK output (16 bits per component).

TURNIT_OUTPUT_IMAGE_FORMAT = 'png16m'

TURNIT_GHOSTSCRIPT_GLOBAL_ARGS

Global settings for ghostscript library.

TURNIT_GHOSTSCRIPT_GLOBAL_ARGS = ['-q',
                                  '-dNOPROMPT',
                                  '-dNOPAUSE',
                                  '-dBATCH',
                                  '-dSAFER', ]

TURNIT_GHOSTSCRIPT_EXTRA_ARGS

Extra parameters for ghostscript. You can add format options here.

TURNIT_GHOSTSCRIPT_EXTRA_ARGS = []