diff --git a/README.md b/README.md index df9b5d6..be58ed2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,39 @@ # wiley-deposits -Wiley Deposits -### Crossref to Dublin Core metadata mapping +## Installation + +To install, clone the repo and run + +``` +pipenv run install + +``` + +To install with development dependencies + +``` +pipenv run install --dev +``` + +## Runnning commands + +To excute a command after installation, run: + +``` +pipenv run awd deposit +``` + +The available commands: + +`deposit` - Process a text file of DOIs to retrieve and send metadata and PDFs as SQS messages to the DSpace Submission Service. Errors generated during the process are emailed to stakeholders. + +`listen` - Retrieve messages from a DSpace Submission output queue and email the results to stakeholders. + +`check-permisions` - Confirm AWD infrastructure has deployed properly with correct permissions to all expected resources given the current env configuration. + +## Crossref to Dublin Core metadata mapping +Metadata is retrieved from the Crossref API and is mapped to Dublin Core according to this crosswalk: Crossref field|DC field|Field notes ------ | ------ | ------- diff --git a/awd/cli.py b/awd/cli.py index f5284ec..fcaa3c6 100644 --- a/awd/cli.py +++ b/awd/cli.py @@ -144,6 +144,9 @@ def deposit( sqs_input_queue, collection_handle, ): + """Process a text file of DOIs to retrieve and send metadata and PDFs as SQS messages + to the DSpace Submission Service. Errors generated during the process are emailed + to stakeholders.""" date = datetime.today().strftime("%m-%d-%Y %H:%M:%S") stream = ctx.obj["stream"] s3_client = s3.S3() @@ -254,6 +257,8 @@ def listen( ctx, retry_threshold, ): + """Retrieve messages from a DSpace Submission output queue and email the + results to stakeholders.""" date = datetime.today().strftime("%m-%d-%Y %H:%M:%S") stream = ctx.obj["stream"] sqs = SQS(ctx.obj["aws_region"])