-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathrdm2eprint.1.html
117 lines (115 loc) · 3.58 KB
/
rdm2eprint.1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<!DOCTYPE html>
<html>
<head>
<title>Institutional Repository Data Management</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu" title="link to Caltech Library Homepage"><img src="https://caltechlibrary.github.io/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="index.html">README</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="INSTALL.html">INSTALL</a></li>
<li><a href="user_manual.html">User Manual</a></li>
<li><a href="search.html">Search Docs</a></li>
<li><a href="about.html">About</a></li>
<li><a href="https://github.com/caltechlibrary/irdmtools">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>rdm2eprint</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>rdm2eprint <a href="#options">OPTIONS</a> RDM_ID</p>
<h1 id="description">DESCRIPTION</h1>
<p>rdm2eprint is a Caltech Library oriented command line application
that takes an RDM record ID and returns a EPrint record JSON document.
It was created to allow us migrate our EPrints repositories minimal
change to our feeds system which works with EPrint structured data. It
uses RDM_URL, RDMTOK, RDM_COMMUNITY_ID environment variables for
configuration. It can read data from a previously harvest RDM record or
directly from RDM via the API url. The tool is intended to run in a pipe
line so have minimal options.</p>
<h1 id="environment">ENVIRONMENT</h1>
<p>The following environment variables can be set at the shell level or
in a “.env” file.</p>
<dl>
<dt>RDM_URL</dt>
<dd>
The URL to the RDM instance
</dd>
<dt>RDMTOK</dt>
<dd>
The application token needed to access the RDM API
</dd>
<dt>RDM_COMMUNITY_ID</dt>
<dd>
The community id used for the RDM collection
</dd>
</dl>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>
display help
</dd>
<dt>-license</dt>
<dd>
display license
</dd>
<dt>-version</dt>
<dd>
display version
</dd>
<dt>-config</dt>
<dd>
provide a path to an alternate configuration file
(e.g. “irdmtools.json”)
</dd>
<dt>-harvest C_NAME</dt>
<dd>
harvest JSON formatted eprint records into the dataset collection
specified by C_NAME.
</dd>
<dt>-ids JSON_ID_FILE</dt>
<dd>
read ids from a file.
</dd>
<dt>-xml</dt>
<dd>
output as EPrint XML rather than JSON, does not work with -harvest.
</dd>
<dt>-pipeline</dt>
<dd>
read from standard input and write crosswalk to standard out.
</dd>
<dt>-latest</dt>
<dd>
only convert record(s) if latest version.
</dd>
</dl>
<h1 id="example">EXAMPLE</h1>
<p>Example generating a EPRINT JSON document from RDM would use the
following variables.</p>
<p>the EPrints repository hosted as “eprints.example.edu” for EPrint ID
118621. Access to the EPrint REST API is configured in the environment.
The result is saved in “article.json”. EPRINT_USER, EPRINT_PASSWORD and
EPRINT_HOST (e.g. eprints.example.edu) via the shell environment.</p>
<pre><code>RDM_URL="__URL_TO_RDM_INSTANCE_HERE__"
RDMTOK="__RDM_ACCESS_TOKEN_HERE__"
RDM_COMMUNITY_ID="rdm.example.edu"
rdm2eprint k3tpc-ga970 >article.json</code></pre>
</section>
<footer>
<span>© 2023 <a href="https://www.library.caltech.edu/copyright">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:[email protected]">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
</body>
</html>