-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #688 from pz-max/zenodo
add zenodo handler
- Loading branch information
Showing
5 changed files
with
128 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # SPDX-FileCopyrightText: PyPSA-Earth and PyPSA-Eur Authors | ||
| # | ||
| # SPDX-License-Identifier: GPL-3.0-or-later |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # SPDX-FileCopyrightText: PyPSA-Earth and PyPSA-Eur Authors | ||
| # | ||
| # SPDX-License-Identifier: GPL-3.0-or-later | ||
|
|
||
| # -*- coding: utf-8 -*- | ||
| """ | ||
| Uploads local files to Zenodo or sandbox.Zenodo. | ||
| Requirements | ||
| ------------ | ||
| - Install zenodopy: pip git+https://github.com/pz-max/zenodopy@patch-4 | ||
| - Setup zenodopy (token): https://github.com/pz-max/zenodopy/tree/patch-4#using-the-package | ||
| - Be aware of Zenodo REST API e.g. for metadata modifications: https://developers.zenodo.org/#introduction | ||
| Relevant Settings | ||
| ----------------- | ||
| """ | ||
| from pathlib import Path | ||
|
|
||
| import zenodopy | ||
|
|
||
| ###################### | ||
| # INPUTS AND OPTIONS # | ||
| ###################### | ||
| SANDBOX_BOOL = True # sandbox should be used for testing | ||
| NEW_PROJECT = False # if False, use existing project ID | ||
| EXISTING_PROJECT_ID = 1183583 | ||
| TYPE = "upload" # 'delete' or 'upload' files | ||
| PUBLISH_BOOL = False # publish repos CANNOT be deleted | ||
| ROOT = "/home/max/Downloads" # example "/home/max/Downloads" | ||
| UPLOAD_PATHS = [ | ||
| "tutorial_data_MA.zip", | ||
| "cutouts_NGBJ.zip", | ||
| ] # list of files from root e.g. "README.md" in /home/max/README.md, each component will receive a download link | ||
| DELETE_PATHS = [ | ||
| "README.md", | ||
| ] # list of files from root e.g. "README.md" in /home/max/README.md, | ||
| METADATA = { | ||
| "title": "PyPSA-Earth (Dataset)", | ||
| "upload_type": "other", | ||
| "description": "Used for model https://github.com/pypsa-meets-earth/pypsa-earth. Multiple data licenses apply https://pypsa-earth.readthedocs.io/en/latest/introduction.html#license", | ||
| "creators": [ | ||
| {"name": "PyPSA-Earth Authors", "affiliation": "PyPSA meets Earth"}, | ||
| ], | ||
| "access_right": "open", | ||
| "license": {"id": "cc-by-4.0"}, | ||
| "keywords": ["Macro Energy Systems", "Power Systems"], | ||
| } # more opton visisble at Zenodo REST API https://developers.zenodo.org/#introduction | ||
|
|
||
|
|
||
| ############# | ||
| # EXECUTION # | ||
| ############# | ||
| zeno = zenodopy.Client(sandbox=SANDBOX_BOOL) # test is API key is set | ||
| zeno.list_projects | ||
|
|
||
|
|
||
| if NEW_PROJECT == True: | ||
| zeno.create_project(title=METADATA["title"]) | ||
| zeno.change_metadata( | ||
| dep_id=zeno.deposition_id, | ||
| metadata=METADATA, | ||
| ) | ||
| for path in UPLOAD_PATHS: | ||
| path = Path.joinpath(Path(ROOT), path) | ||
| zeno.upload_zip(source_dir=str(path)) | ||
|
|
||
|
|
||
| if NEW_PROJECT == False: | ||
| zeno.set_project(dep_id=EXISTING_PROJECT_ID) | ||
| zeno.change_metadata( | ||
| dep_id=zeno.deposition_id, | ||
| metadata=METADATA, | ||
| ) | ||
| for path in UPLOAD_PATHS: | ||
| path = Path.joinpath(Path(ROOT), path) | ||
| if path.exists(): | ||
| if TYPE == "upload": | ||
| if path.exists(): | ||
| try: | ||
| if path.is_file(): | ||
| zeno.upload_file(str(path)) | ||
| elif path.is_dir(): | ||
| zeno.upload_zip(str(path)) | ||
| except: | ||
| zeno.update(path) | ||
| continue | ||
|
|
||
| if TYPE == "delete": | ||
| try: | ||
| zeno.delete_file(str(path)) | ||
| except: | ||
| print(f"Cannot delete {path}. Repo needs to be in edit mode.") | ||
| else: | ||
| raise FileNotFoundError(f"{path} does not exist") | ||
|
|
||
|
|
||
| if PUBLISH_BOOL == True: | ||
| zeno.publish() | ||
|
|
||
|
|
||
| zeno.list_projects |
File renamed without changes.