Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.83 KB

README.md

File metadata and controls

52 lines (37 loc) · 1.83 KB
Raw

CGSpace Submission Guidelines

A set of scripts to read submission-forms.xml from DSpace and generate documentation about metadata and controlled vocabularies. This is used as guidance for programmatic submission to the CGSpace repository.

Screenshot of documentation website

You can see the website here: https://ilri.github.io/cgspace-submission-guidelines

Requirements

Requires the following on the host machine:

  • Python 3.10+
  • Node.js v16 and npm
  • Hugo

Preparation

Creatve and initialize the Python virtual environment:

$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt

Install dependencies with npm and build the static CSS and JavaScript assets:

$ npm install
$ npm run build

Usage

Make sure the Python virtual environment is active and then run parse-input-forms.py to extract and process the DSpace metadata and controlled vocabularies:

$ source .venv/bin/activate
$ ./util/parse-input-forms.py -i ~/src/git/DSpace/dspace/config/submission-forms.xml -c ~/src/git/DSpace/dspace/config/controlled-vocabularies --clean

Generate the documentation site using Hugo:

$ hugo

You can view a local development version using hugo serve. The site will be available on: http://localhost:1313/cgspace-submission-guidelines/

License

This work is licensed under the GPLv3.

The license allows you to use and modify the work for personal and commercial purposes, but if you distribute the work you must provide users with a means to access the source code for the version you are distributing. Read more about the GPLv3 at TL;DR Legal.