Skip to content

Commit

Permalink
Clarify that /eprint is automatically added to the API URL
Browse files Browse the repository at this point in the history
  • Loading branch information
mhucka committed Dec 19, 2018
1 parent e7f45a5 commit b7cdf21
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ On Linux and macOS systems, assuming that the installation proceeds normally, yo
▶︎ Using Eprints2bags
---------------------

`eprints2bags` contacts an EPrints REST server whose network API is accessible at the URL given by the command-line option `-a` (or `/a` on Windows). A typical EPrints server URL has the form `https://somename.yourinstitution.edu/rest`. The `-a` (or `/a`) option is required; the program cannot infer the server address on its own.
`eprints2bags` contacts an EPrints REST server whose network API is accessible at the URL given by the command-line option `-a` (or `/a` on Windows). A typical EPrints server URL has the form `https://somename.yourinstitution.edu/rest`. **This program will automatically add `/eprint` to the URL path given**, so omit that part of the URL in the value given to `-a`. The `-a` (or `/a`) option is required; the program cannot infer the server address on its own.

The EPrints records to be written will be limited to the list of numerical EPrints identifiers found in the file given by the option `-i` (or `/i` on Windows). If no `-i` option is given, `eprints2bags` will download all the contents available at the given EPrints server. The value of `-i` can also be one or more integers separated by commas (e.g., `-i 54602,54604`), or a range of numbers separated by a dash (e.g., `-i 1-100`, which is interpreted as the list of numbers 1, 2, ..., 100 inclusive), or some combination thereof.

Expand Down
4 changes: 3 additions & 1 deletion eprints2bags/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ def main(api_url = 'A', base_name = 'B', final_fmt = 'F', id_list = 'I',
This program contacts an EPrints REST server whose network API is accessible
at the URL given by the command-line option -a (or /a on Windows). A typical
EPrints server URL has the form "https://server.institution.edu/rest".
EPrints server URL has the form "https://server.institution.edu/rest". This
program will automatically add "/eprint" to the URL path, so omit that part
of the URL in the value given to -a.
The EPrints records to be written will be limited to the list of EPrints
numbers found in the file given by the option -i (or /i on Windows). If no
Expand Down

0 comments on commit b7cdf21

Please sign in to comment.