Merge branch 'master' of https://github.com/caltechlibrary/epxml_to_datacite

Author: tmorrell

README.md

@@ -29,36 +29,52 @@ their Eprints installation.
 If you want to download metadata from Eprints, you need to install
 [eprint-tools](https://github.com/caltechlibrary/eprinttools)
 
+## Options
 
-### Advanced
+There are three different scripts
 
-You can also import the metadata transformation function into another python script by typing
-`python setup.py install` in the epxml_to_datacite directory.  Then include 
-`import caltech_thesis` at the top of your new script and you wil be able to
-call `epxml_to_datacite(eprint)`, where eprint is the xml parsed by something
-like:
+- `caltech_thesis.py`
+- `caltech_authors_to_data.py` (Prepares metadata from CaltechAUTHORS for submission to CaltechDATA)
+- `caltech_authors_tech_report.py` (Prepares metadata from CaltechAUTHORS tech reports  with `monograph` item type (Report or Paper))
 
-```
-infile = open('10271.xml',encoding="utf8")
-eprint = xmltodict.parse(infile.read())['eprints']['eprint']
-```
+In this documentation we use `caltech_thesis.py` as the example script, but in most cases you can substitute one of the other sources.
+
+## Basic operation
+
+If you have Eprints XML files (from thesis.library.caltech.edu/rest/eprint/1234.xml, for example), put them in the epxml_to_datacite folder.  Type
+
+`python caltech_thesis.py`
+
+And you'll get '\_datacite.xml' for each xml file in the folder
 
-## Downloading Eprints XML files
+## Downloading Eprints XML
 
 You can use Eprints ids (e.g. 82938) to download Eprints xml files by adding a
 `-ids` option to any command.  This requires eputil to be installed on your local systems.
 
+`python caltech_thesis.py -ids 82938`
+
 Alternativly, you can provide a tsv file, where the first column is the Eprints
 id using the `-id_file` option
 
-## Using caltech_thesis.py
+`python caltech_thesis.py -id_file ids.tsv`
+
+## Mint DOIs
 
-Download .xml files from thesis.library.caltech.edu/rest/eprint/1234.xml and put 
-them in the folder with caltech_thesis.py.  Type `python caltech_thesis` and
-DataCite XML files will appear.  If you want to mint DOIs add the `-mint`
-option and if you want to make test DOIs add the `-test` option to the command
-line.  
+You can also have the script submit the metadata to DataCite and add the DOI to the source repository. Add the `-mint`
+option and if you want to make test DOIs add the `-test` option to the command line.  
 
-## Using caltech_authors_tech_report.py
+`python caltech_thesis.py -mint -ids 82938`
+
+### Advanced
+
+You can also import the metadata transformation function into another python script by typing
+`python setup.py install` in the epxml_to_datacite directory.  Then include 
+`import caltech_thesis` at the top of your new script and you wil be able to
+call `epxml_to_datacite(eprint)`, where eprint is the xml parsed by something
+like:
 
-Will only work with items with the `monograph` item type (Report or Paper).
+```
+infile = open('10271.xml',encoding="utf8")
+eprint = xmltodict.parse(infile.read())['eprints']['eprint']
+```

codemeta.json

@@ -6,7 +6,7 @@
   "codeRepository": "https://github.com/caltechlibrary/epxml_to_datacite",
   "issueTracker": "https://github.com/caltechlibrary/epxml_to_datacite/issues",
   "license": "https://data.caltech.edu/license",
-  "version": "0.11.5",
+  "version": "0.11.6",
   "author": [
     {
       "@type": "Person",
@@ -17,7 +17,7 @@
       "@id": "https://orcid.org/0000-0001-9266-5146"
     }],
   "developmentStatus": "active",
-  "downloadUrl": "https://github.com/caltechlibrary/ames/archive/v0.11.5.zip",
+  "downloadUrl": "https://github.com/caltechlibrary/ames/archive/v0.11.6.zip",
   "keywords": [
     "GitHub",
     "Eprints",