-
María José Ramos authoredd437ff47
Git&Zenodo Assistant
This repository contains the Git&Zenodo Assistant program, named tutorial.py
, and the requirements.sh
file to install the python libraries needed to run the program. It also contains 4 directories, which correspond to the packages of the program (git_assistant
, zenodo_assistant
); a metadata
folder which contains .csv files with the controlled vocabulary of Zenodo's metadata; a test_tutorial
folder with a test.txt
file, to be used for the testing the program, and a images_tutorial
with screenshots of the GitHub and Zenodo's websites to help you in creating your token.
When running the Git&Zenodo Assistant program, you will see the main menu, which gives you five options to choose from:
- By typing a, you will enter the Git Tutorial. In this section, you can learn how to git push a file by executing Git commands, without needing to type them so you can focus on learning about Git.
- By typing b, you will enter the Zenodo Assistant, which works with the Zenodo Rest API. You will not have to type any commands, but you will need to provide the location of your file and some basic information about your upload (the title of your work, its creators, etc).
- By typing c or d, you can see the links to the official documentation of Git and Zenodo respectively.
- By typing e, you can exit the program.
To avoid problems while using the program remember to install the requirements by following the instructions below; create your Git and/or Zenodo account beforehand; and have your authentication information: (your username and password/token)
Git clone
To get all the files in this repository and use the program, clone the file to your local machine or to the ATLAS Virtual Machine by opening the terminal and typing:
git clone https://gitmilab.redclara.net/ramosm/git-zenodo-assistant.git