download_sivacor.py - Download SIVACOR submission artifacts

Description¶

Downloads all artifacts associated with a SIVACOR submission ID, handles ZIP file extraction, and commits the results to a git branch. Automates the workflow of fetching SIVACOR submissions and integrating them into the repository.

Usage¶

python3 tools/download_sivacor.py [JIRA_CASE]

Arguments¶

• JIRA_CASE (optional) - Jira case number (e.g., aearep-8885)

The script determines the Jira case in this order of precedence:

1. Command line argument

2. Current directory name (if starts with aearep-)

3. jiraticket field in config.yml

Examples¶

# Using current directory name as Jira case
cd aearep-8885
python3 tools/download_sivacor.py

# Specifying Jira case explicitly
python3 tools/download_sivacor.py aearep-8885

# Using config.yml (jiraticket field)
python3 tools/download_sivacor.py

Requirements¶

• Python >= 3.6

• jira: Python Jira library

• yaml: YAML configuration file support

• sivacor: SIVACOR CLI tool (installed via pip)

Environment Variables Required¶

• JIRA_USERNAME - Your Jira email address

• JIRA_API_KEY - API token from https://id.atlassian.com/manage-profile/security/api-tokens

• SIVACOR environment variables as required by sivacor CLI

Workflow¶

1. Determines Jira case from argument, directory name, or config.yml

2. Looks up SIVACOR ID from Jira ticket

3. Determines target folder from config.yml (precedence: openicpsr > zenodo > dataverse > osf)

4. Downloads all artifacts using sivacor CLI

5. If ZIP file exists:

   • Clears folder contents (keeping folder)

   • Unpacks ZIP

   • Downloads other artifacts

6. Creates branch sivacor-{sivacor_id} (lowercase)

7. Git adds and commits the folder

Error Handling¶

• Exits with error if SIVACOR ID field is not populated in Jira

• Validates target folder existence

• Handles missing config.yml gracefully

See Also¶

• Pipeline 8-download-sivacor in bitbucket-pipelines.yml