facile_rs.create_radar

Create an archive in the RADAR service.

Description

This script creates an archive in the RADAR service and uploads the assets provided as positional arguments. The metadata is created similar to create_datacite.

If the RADAR ID is already present in the CodeMeta file, the existing RADAR archive is updated instead.

Usage

usage: create_radar.py [-h] --codemeta-location CODEMETA_LOCATION
                       [--creators-locations CREATORS_LOCATIONS]
                       [--contributors-locations CONTRIBUTORS_LOCATIONS]
                       [--no-sort-authors] [--radar-path RADAR_PATH]
                       --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
                       [--smtp-server SMTP_SERVER]
                       [--notification-email NOTIFICATION_EMAIL]
                       [--assets-token ASSETS_TOKEN]
                       [--assets-token-name ASSETS_TOKEN_NAME] [--dry]
                       [--overwrite] [--log-level LOG_LEVEL]
                       [--log-file LOG_FILE]
                       [ASSETS ...]

Positional Arguments

ASSETS

Assets to be added to the repository.

Default: []

Named Arguments

--codemeta-location

Location of the main codemeta.json JSON file

--creators-locations, --creators-location

Locations of codemeta JSON files for additional creators

Default: []

--contributors-locations, --contributors-location

Locations of codemeta JSON files for additional contributors

Default: []

--no-sort-authors

Do not sort authors alphabetically, keep order in codemeta.json file

Default: True

--radar-path

Path to the local directory, where the assets are collected before upload. Optional: if not provided, a temporary directory is used.

--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.

--smtp-server

SMTP server used to inform about new release. No mail sent if empty.

--notification-email

Recipient address to inform about new release. No mail sent if empty.

--assets-token

Private token, to be used when fetching assets

--assets-token-name

Name of the header field for the token [default: “PRIVATE-TOKEN”]

Default: 'PRIVATE-TOKEN'

--dry

Perform a dry run, do not upload anything.

Default: False

--overwrite

Overwrite existing local assets.

Default: False

--log-level

Log level (ERROR, WARN, INFO, or DEBUG)

Default: 'WARN'

--log-file

Path to the log file

Module Contents

Functions

create_parser
main
main_deprecated

API

create_parser(add_help=True)

main(args)

main_deprecated()