Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

View plugin for rendering PDFs on the browser

Project Description


This extension provides a view plugin for PDF files using PDF.js.

Beyond viewing PDFs, this version takes advantage of the latest PDF.js features that were not available in the bundled pre 2.3 viewer, namely:

  • Localization. Uses CKAN’s language settings when possible.
  • Tools Menu. Go to first/last page. Rotate clockwise/counter-clockwise. Hand tool. Document Properties.
  • Fullscreen support.
  • PDF attachment support.
  • Performance. Renders PDFs much faster in browsers with WebGL and Web Worker support.
  • Implements hundreds of PDF.js bug fixes


This extension only works with CKAN >= 2.3. On previous CKAN versions the PDF viewer is included in the main CKAN repository.


To install ckanext-pdfview:

  1. Activate your CKAN virtual environment, for example:

    source /usr/lib/ckan/default/bin/activate
  2. Install the ckanext-pdfview Python package into your virtual environment:

    pip install ckanext-pdfview
  3. Add pdf_view to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. If you want to render PDF files which are not located in the same server as CKAN you also need to enable the resource_proxy plugin.

  1. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Development Installation

To install ckanext-pdfview for development, activate your CKAN virtualenv and do:

git clone
cd ckanext-pdfview
python develop

Running the Tests

To run the tests, do:

nosetests --nologcapture --ckan --with-pylons=test.ini

Registering ckanext-pdfview on PyPI

ckanext-pdfview should be availabe on PyPI as If that link doesn’t work, then you can register the project on PyPI for the first time by following these steps:

  1. Create a source distribution of the project:

    python sdist
  2. Register the project:

    python register
  3. Upload the source distribution to PyPI:

    python sdist upload
  4. Tag the first release of the project on GitHub with the version number from the file. For example if the version number in is 0.0.1 then do:

    git tag 0.0.1
    git push --tags

Releasing a New Version of ckanext-pdfview

ckanext-pdfview is availabe on PyPI as To publish a new version to PyPI follow these steps:

  1. Update the version number in the file. See PEP 440 for how to choose version numbers.

  2. Create a source distribution of the new version:

    python sdist
  3. Upload the source distribution to PyPI:

    python sdist upload
  4. Tag the new release of the project on GitHub with the version number from the file. For example if the version number in is 0.0.2 then do:

    git tag 0.0.2
    git push --tags

Source Install Troubleshooting

AttributeError: ‘module’ object has no attribute ‘ckanext-pdfview/main’

When upgrading a CKAN source install to 2.3+, be sure to remove the old bundled pdfview.

rm -rf /usr/lib/ckan/default/src/ckan/ckanext/pdfview

pdfview used to be part of CKAN core, and has been made a separate extension to make it easier to iterate on pdf viewer enhancements.

Also, be sure be sure to register any new or updated plugins:

. /usr/lib/ckan/default/bin/activate
cd /usr/lib/ckan/default/src/ckan
python develop

Release History

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
(1.5 MB) Copy SHA256 Hash SHA256
Source None Dec 2, 2015

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Kabu Creative Kabu Creative UX & Design Google Google Cloud Servers Fastly Fastly CDN StatusPage StatusPage Statuspage DigiCert DigiCert EV Certificate