facile_rs.prepare_radar¶
Create an empty archive in the RADAR service to reserve a DOI and a RADAR ID.
Description¶
This script creates an empty archive in the RADAR service in order to reserve a DOI and a RADAR ID.
Both are stored in the CodeMeta metadata file provided as input and can be later used by the script create_radar.py
to populate the RADAR archive.
Usage¶
usage: prepare_radar.py [-h] [--codemeta-location CODEMETA_LOCATION]
--radar-url RADAR_URL --radar-username RADAR_USERNAME
--radar-password RADAR_PASSWORD --radar-client-id
RADAR_CLIENT_ID --radar-client-secret
RADAR_CLIENT_SECRET --radar-workspace-id
RADAR_WORKSPACE_ID --radar-redirect-url
RADAR_REDIRECT_URL --radar-email RADAR_EMAIL
--radar-backlink RADAR_BACKLINK [--keep-previous-doi]
[--dry] [--log-level LOG_LEVEL] [--log-file LOG_FILE]
Named Arguments¶
- --codemeta-location
Location of the main codemeta.json JSON file
- --radar-url
URL of the RADAR service.
- --radar-username
Username for the RADAR service.
- --radar-password
Password for the RADAR service.
- --radar-client-id
Client ID for the RADAR service.
- --radar-client-secret
Client secret for the RADAR service.
- --radar-workspace-id
Workspace ID for the RADAR service.
- --radar-redirect-url
Redirect URL for the OAuth workflow of the RADAR service.
- --radar-email
Email for the RADAR metadata.
- --radar-backlink
Backlink for the RADAR metadata.
- --keep-previous-doi
When creating a new version, keep the previous DOI in the Codemeta file, in the field “isBasedOn”. By default, the previous DOI is removed.
Default:
False- --dry
Perform a dry run, do not upload anything.
Default:
False- --log-level
Log level (ERROR, WARN, INFO, or DEBUG)
Default:
'WARN'- --log-file
Path to the log file
Module Contents¶
Functions¶
API¶
- create_parser(add_help=True)¶
- main(args)¶
- main_deprecated()¶