Skip to content

Commit

Permalink
Update usage examples in README (#56)
Browse files Browse the repository at this point in the history
This should have been included with #52.
  • Loading branch information
Mark A. Matney, Jr authored Sep 12, 2023
1 parent ad91577 commit dcbfcf0
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/main/scripts/import-items/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,15 @@ PATH=$PATH:$HOME/path/to/UCLALibrary/hauth/src/main/scripts/import-items

## Example usage

Assuming that all CSV files in the current working directory contain open access items, and a Hauth instance is running at http://example.com:
When every item in each CSV file has a `Visibility` value, usage will look something like this:

```bash
./import-items.py --api-key=0123456789ABCDEF http://example.com *.csv
```

where http://example.com is the base URL of the Hauth service.

To import every item in each CSV file with a particular access mode (ignoring the `Visibility` column), the `--access-mode` flag is available as a sort of "override":

```bash
./import-items.py --api-key=0123456789ABCDEF --access-mode=OPEN http://example.com *.csv
Expand Down

0 comments on commit dcbfcf0

Please sign in to comment.