Skip to main content

View plugin for rendering PDFs on the browser

Project description

https://travis-ci.org/ckan/ckanext-pdfview.svg?branch=master Downloads Latest Version Supported Python versions Development Status License

ckanext-pdfview

This extension provides a view plugin for PDF files using an html object tag.

Requirements

This extension works with CKAN >= 2.7 and runs both on Python 2.7 and 3.6+.

Installation

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 https://github.com/ckan/ckanext-pdfview.git
cd ckanext-pdfview
pip install -r dev-requirements.txt
python setup.py develop

Running the Tests

To run the tests, do:

pytest --ckan-ini=test.ini ckanext/pdfview

Registering ckanext-pdfview on PyPI

ckanext-pdfview should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-pdfview. 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 setup.py sdist
  2. Register the project:

    python setup.py register
  3. Upload the source distribution to PyPI:

    python setup.py sdist upload
  4. Tag the first release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py 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 https://pypi.python.org/pypi/ckanext-pdfview. To publish a new version to PyPI follow these steps:

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

  2. Create a source distribution of the new version:

    python setup.py sdist
  3. Upload the source distribution to PyPI:

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

    git tag 0.0.2
    git push --tags

Project details


Download files

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

Source Distribution

ckanext-pdfview-0.0.6.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file ckanext-pdfview-0.0.6.tar.gz.

File metadata

  • Download URL: ckanext-pdfview-0.0.6.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.6.0 requests/2.20.0 setuptools/44.1.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/2.7.18rc1

File hashes

Hashes for ckanext-pdfview-0.0.6.tar.gz
Algorithm Hash digest
SHA256 c245f85c76e9135d498090f417c8b1ea52b50109428c1c31663de67e179a388a
MD5 3bf8729c44cf48e8048e56dabc6ada57
BLAKE2b-256 52722014fe2659822aef6f66a0907c0742efebbcd5d6d92fc822c3d368ba821c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page