API Docs

Invenio module for document management.

class invenio_documents.ext.InvenioDocuments(app=None)

Invenio-Documents extension.

init_app(app)

Flask application initialization.

Document

Implement the API for document management.

class invenio_documents.api.Document

Represent a file in record object.

copy(dst, **kwargs)

Copy file to a new destination.

Returns JSON Patch with proposed change pointing to new copy.

move(dst, **kwargs)

Move file to a new destination and update uri.

open(mode='r', **kwargs)

Open file uri under the pointer.

remove(force=False)

Remove file reference from record.

If force is True it removes the file from filesystem

setcontents(source, **kwargs)

Create a new file from a string or file-like object.

uri

Read uri from given record.

CLI

Click command-line interface for document management.

invenio_documents.cli.copy_document = <click.core.Command object>

Copy file to a new destination.

invenio_documents.cli.setcontents = <click.core.Command object>

Patch existing bibliographic record.