zenodo / zenodo-gsoc

Repository for all GSoC 2017-specific things.

Zenodo - Research. Shared.

Zenodo, a CERN service, is an open dependable home for the long-tail of science, enabling researchers to share and preserve any research outputs in any size, any format and from any science.

Powered by Invenio

Zenodo is a small layer on top of Invenio, a ​free software suite enabling you to run your own ​digital library or document repository on the web.

Installation

See INSTALL.rst

Developer documentation

See https://zenodo.readthedocs.io/

License

Copyright (C) 2009-2017 CERN.

Zenodo is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Zenodo is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Zenodo; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction.

Zenodo (R)

Zenodo (R) and the Zenodo logo are trademarked by CERN and are not covered by the GPLv2 license. Thus, if you instantiate Zenodo on your own servers you must change the branding to your own.

Please consider creating your own overlay to Invenio and look at Zenodo for inspiration.

zenodo-gsoc's Issues

deposit-ui: mockup button for "extraction" of a metadata from a deposit file

1. Each uploaded file entry on the top of deposit form should render an "Extract metadata" button, e.g. next to the "Delete" icon.

2. On click, the button should make an asynchronous POST request to an endpoint (for now it can live here: https://github.com/zenodo/zenodo/blob/master/zenodo/modules/deposit/views.py), and get a JSON response. In the parameters it should pass the file information (UUID).

An example of a deposit form button code, which pre-reserves the DOI of the record: https://github.com/zenodo/zenodo/blob/master/zenodo/modules/deposit/templates/zenodo_deposit/edit.html#L88-L136

1. For now the returned response can be a dummy JSON such as:

{
   "title": "Foobar title"
   "description": "Some description"
   "file_id": <file object UUID again>
}

1. After receiving the response, it should pre-filtered the title+description metadata on the form.

2. Finally, it should not just pre-filter the metadata automatically, but display a bootstrap modal, where user can select which of the metadata fields he wants to overwrite on the form.

Some limitations for now, but good to think about:

• The view will "extract" the metadata in the application process, so no celery is required for now.
• On the client side (JS), we can just wait for the response, however, we shouldn't do it if it's a large job (e.g. parsing a large PDF might take a while). In the final implementation we might need to:
  • Start the extraction (on button click).
  • On the client side (JS), ping the endpoint every few seconds to check if the job is finished.