API Docs

Invenio module for previewing files.

class invenio_previewer.ext.InvenioPreviewer(app, **kwargs)

Invenio-Previewer extension.

Extension initialization.

init_app(app, entry_point_group='invenio_previewer.previewers')

Flask application initialization.

init_config(app)

Initialize configuration.

invenio_previewer.ext.load_or_import_from_config(key, app=None, default=None)

Load or import value from config.

invenio_previewer.ext.obj_or_import_string(value, default=None)

Import string or return object.

API

File reader utility.

class invenio_previewer.api.PreviewFile(pid, record, fileobj)

Preview file default implementation.

Default constructor.

Parameters:file – ObjectVersion instance from Invenio-Files-REST.

bucket

Get bucket.

filename

Get filename.

has_extensions(*exts)

Check if file has one of the extensions.

is_local()

Check if file is local.

open()

Open the file.

size

Get file size.

uri

Get file download link.

Note

The URI generation assumes that you can download the file using the view invenio_records_ui.<pid_type>_files.

Proxies

Proxy for current previewer.

invenio_previewer.proxies.current_previewer = <LocalProxy unbound>

Proxy object to the current previewer extension.

Utils

Invenio Previewer Utilities.

invenio_previewer.utils.detect_encoding(fp, default=None)

Detect the character encoding of a file.

Parameters:

• fp – Open Python file pointer.
• default – Fallback encoding to use.

Returns:

The detected encoding.

Note

The file pointer is returned at its original read position.

Views

View method for Invenio-Records-UI for previewing files.

invenio_previewer.views.blueprint = <flask.blueprints.Blueprint object>

Blueprint used to register template and static folders.

invenio_previewer.views.is_previewable(extension)

Test if a file can be previewed checking its extension.

invenio_previewer.views.preview(pid, record, template=None, **kwargs)

Preview file for given record.

Plug this method into your RECORDS_UI_ENDPOINTS configuration:

RECORDS_UI_ENDPOINTS = dict(
    recid=dict(
        # ...
        route='/records/<pid_value/preview/<path:filename>',
        view_imp='invenio_previewer.views.preview',
        record_class='invenio_records_files.api:Record',
    )
)

Webpack

JS/CSS bundles for Previewer.

invenio_previewer.webpack.previewer = <invenio_assets.webpack.WebpackThemeBundle object>

Bundle of webpack assets.

Previewers

CSV (d3.js)

Render a CSV file using d3.js.

invenio_previewer.extensions.csv_dthreejs.can_preview(file)

Determine if the given file can be previewed.

invenio_previewer.extensions.csv_dthreejs.preview(file)

Render the appropriate template with embed flag.

invenio_previewer.extensions.csv_dthreejs.validate_csv(file)

Return dialect information about given csv file.

Default

Default rendering returning a default web page.

invenio_previewer.extensions.default.can_preview(file)

Return if file type can be previewed.

invenio_previewer.extensions.default.preview(file)

Return the appropriate template and passes the file and embed flag.

JSON (prism.js)

Previews a JSON file.

invenio_previewer.extensions.json_prismjs.can_preview(file)

Determine if the given file can be previewed.

invenio_previewer.extensions.json_prismjs.preview(file)

Render the appropriate template with embed flag.

invenio_previewer.extensions.json_prismjs.render(file)

Pretty print the JSON file for rendering.

invenio_previewer.extensions.json_prismjs.validate_json(file)

Validate a JSON file.

Markdown

Markdown rendering using mistune library.

invenio_previewer.extensions.mistune.can_preview(file)

Determine if file can be previewed.

invenio_previewer.extensions.mistune.preview(file)

Render Markdown.

invenio_previewer.extensions.mistune.render(file)

Render HTML from Markdown file content.

PDF (pdf.js)

PDF previewer based on pdf.js.

invenio_previewer.extensions.pdfjs.can_preview(file)

Check if file can be previewed.

invenio_previewer.extensions.pdfjs.preview(file)

Preview file.

Simple Images

Previews simple image files.

invenio_previewer.extensions.simple_image.can_preview(file)

Determine if the given file can be previewed.

invenio_previewer.extensions.simple_image.preview(file)

Render the appropriate template with embed flag.

invenio_previewer.extensions.simple_image.validate(file)

Validate a simple image file.

XML (prism.js)

Previews an XML file.

invenio_previewer.extensions.xml_prismjs.can_preview(file)

Determine if the given file can be previewed.

invenio_previewer.extensions.xml_prismjs.preview(file)

Render appropiate template with embed flag.

invenio_previewer.extensions.xml_prismjs.render(file)

Pretty print the XML file for rendering.

invenio_previewer.extensions.xml_prismjs.validate_xml(file)

Validate an XML file.

ZIP

Simple ZIP archive previewer.

invenio_previewer.extensions.zip.can_preview(file)

Return True if filetype can be previewed.

invenio_previewer.extensions.zip.children_to_list(node)

Organize children structure.

invenio_previewer.extensions.zip.make_tree(file)

Create tree structure from ZIP archive.

invenio_previewer.extensions.zip.preview(file)

Return the appropriate template and pass the file and an embed flag.