annotate README @ 3:c1918aa337c4

v0.2 small bug fixes
author Marco Fabiani <marco.fabiani@eecs.qmul.ac.uk>
date Wed, 28 Mar 2012 17:48:59 +0100
parents 2ceacc9bb602
children ed98a232e4a5
rev   line source
marco@1 1 SWORD2 DSpace bulk uploader
marco@1 2 --------------------
marco@1 3
marco@1 4 A python script to submit large numbers of files to a SWORD2-compatible repository, specifically DSpace 1.8x.
marco@1 5 Built on the SWORD2 python client library: https://bitbucket.org/beno/python-sword2/overview
marco@1 6
marco@1 7 Dependencies:
marco@1 8
marco@1 9 - python 2.X
marco@1 10
marco@1 11 - sword2 library: https://bitbucket.org/beno/python-sword2/src
marco@1 12
marco@1 13 Installation:
marco@1 14
marco@1 15 - no installation required, simply copy the script sworduploader.py to a suitable location. The first time you run the script, it will create the sword2_logging.conf file.
marco@1 16
marco@1 17 Usage:
marco@1 18
marco@3 19 sworduploader[-h] [--username USER_NAME] [--title TITLE]
marco@1 20 [--author AUTHOR [AUTHOR ...]] [--date DATE]
marco@1 21 [--servicedoc DSPACEURL]
marco@1 22 data
marco@1 23
marco@1 24 Bulk upload to DSpace using SWORDv2.
marco@1 25
marco@1 26 positional arguments:
marco@1 27 data Accepts: METSDSpaceSIP packages, zip files,
marco@1 28 directories, single files. NOTE: METSDSpaceSIP packages are
marco@1 29 only accepted by Collections with a workflow!
marco@1 30
marco@1 31 optional arguments:
marco@1 32 -h, --help show this help message and exit
marco@1 33 --username USER_NAME DSpace username.
marco@1 34 --title TITLE Title (ignored for METS packages).
marco@1 35 --author AUTHOR [AUTHOR ...]
marco@1 36 Author(s) (ignored for METS packages). Accepts
marco@1 37 multiple entries in the format "Surname, Name"
marco@1 38 --date DATE Date of creation (string) (ignored for METS packages).
marco@1 39 --servicedoc DSPACEURL
marco@1 40 Url of the SWORDv2 service document (default:
marco@1 41 http://c4dm.eecs.qmul.ac.uk/smdmrd-
marco@1 42 test/swordv2/servicedocument
marco@1 43
marco@1 44 If the submission is created successfully, it will remain open to be completed
marco@1 45 with the necessary metadata and licenses, using the DSpace web interface. The
marco@1 46 submission can be found in the "My Account -> Submissions" section of the
marco@1 47 user's area.
marco@1 48
marco@1 49 Source:
marco@1 50
marco@1 51 https://code.soundsoftware.ac.uk/projects/sworduploader/repository
marco@1 52
marco@1 53 -----------------------------------------------
marco@1 54 Copyright 2012 Marco Fabiani
marco@1 55 Copyright 2012 Queen Mary, University of London
marco@1 56 ------------------------------------------------