ckanext-pdfview 0.0.6 on PyPI

https://travis-ci.org/ckan/ckanext-pdfview.svg?branch=master

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:

Activate your CKAN virtual environment, for example:
```
source /usr/lib/ckan/default/bin/activate
```
Install the ckanext-pdfview Python package into your virtual environment:
```
pip install ckanext-pdfview
```
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).
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.

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:

Create a source distribution of the project:
```
python setup.py sdist
```
Register the project:
```
python setup.py register
```
Upload the source distribution to PyPI:
```
python setup.py sdist upload
```
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:

Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.
Create a source distribution of the new version:
```
python setup.py sdist
```
Upload the source distribution to PyPI:
```
python setup.py sdist upload
```
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
```