diff README @ 12:ed98a232e4a5

Updated license
author Marco Fabiani <marco.fabiani@eecs.qmul.ac.uk>
date Wed, 18 Apr 2012 11:03:57 +0100
parents c1918aa337c4
children 273fc80d9623
line wrap: on
line diff
--- a/README	Wed Apr 18 10:53:19 2012 +0100
+++ b/README	Wed Apr 18 11:03:57 2012 +0100
@@ -2,18 +2,26 @@
 --------------------
 
 A python script to submit large numbers of files to a SWORD2-compatible repository, specifically DSpace 1.8x.
-Built on the SWORD2 python client library: https://bitbucket.org/beno/python-sword2/overview
+Built on the SWORD2 python client library: https://bitbucket.org/beno/python-sword2/overview with modifications.
 
+-----------------------------------------------
+Source:
+
+https://code.soundsoftware.ac.uk/projects/sworduploader/repository
+
+-----------------------------------------------
 Dependencies:
 
 - python 2.X
 
-- sword2 library: https://bitbucket.org/beno/python-sword2/src
+- sword2 library, with modifications: https://bitbucket.org/marcofabiani/python-sword2/src 
 
+-----------------------------------------------
 Installation:
 
 - 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.
 
+-----------------------------------------------
 Usage:
 
 sworduploader[-h] [--username USER_NAME] [--title TITLE]
@@ -24,13 +32,17 @@
 Bulk upload to DSpace using SWORDv2.
 
 positional arguments:
-  data                  Accepts: METSDSpaceSIP packages, zip files,
-                        directories, single files. NOTE: METSDSpaceSIP packages are
-			only accepted by Collections with a workflow!
+  data                  Accepts: METSDSpaceSIP and BagIt packages, simple zip
+                        files, directories, single files. NOTE: METSDSpaceSIP
+                        packages are only accepted by Collections with a
+                        workflow!
 
 optional arguments:
   -h, --help            show this help message and exit
   --username USER_NAME  DSpace username.
+  --zip                 If "data" is a directory, compress it and post it as a
+                        single file. The zip file will be saved along with the
+                        individual files.
   --title TITLE         Title (ignored for METS packages).
   --author AUTHOR [AUTHOR ...]
                         Author(s) (ignored for METS packages). Accepts
@@ -46,11 +58,3 @@
 submission can be found in the "My Account -> Submissions" section of the
 user's area.
 
-Source:
-
-https://code.soundsoftware.ac.uk/projects/sworduploader/repository
-
------------------------------------------------
-Copyright 2012 Marco Fabiani
-Copyright 2012 Queen Mary, University of London
-------------------------------------------------
\ No newline at end of file