push2HAL is a basic Python library dedicated to data uploading on HAL database. It will use the classical API of HAL to get information and the SWORD one to upload content. Two main executables are provided (for UNIX use only):

• pdf2hal is able to upload a PDF file to an existing notice on HAL (only with valid permission to modify it).
• json2hal is able to build the necessary data from a JSON file to create a new notice in HAL and upload it directly with or without providing a PDF file.

pdf2hal - Upload PDF file to an existing notice in HAL

pdf2hal proposes an interactive mode to upload a PDF to the right/selected notice in HAL by extracting basic data from the PDF file and executing a search on HAL database

Usage:

usage: pdf2hal [-h] [-a HALID] [-c CREDENTIALS] [-v] [-e] [-l LOGIN] [-p PASSWD] [-f] pdf_path

Arguments

• positional argument: pdf_path Path to the PDF file

• optional arguments:

short	long	default	help
-h	--help		show this help message and exit
-a	--halid	None	HALid of document to update
-c	--credentials	None	Path to the credentials file
-v	--verbose		Show all logs
-e	--prod		Execute on production server (use with caution)
-t	--test		Execute on prod server as test (dryrun)
-l	--login	None	Username for API (HAL)
-p	--passwd	None	Password for API (HAL)
-cc	--complete	None	Run completion (use grobid, idext or affiliation or list of terms separated by comma)
-id	--idhal	None	idHal to link deposit to specific user

json2hal - Create a new note on HAL w/- or w/o additional file

json2hal is able to create a note on HAL based on content provided in a JSON file. Additional (PDF) could be provided and uploaded on the same time

Usage:

usage: json2hal [-h] [-c CREDENTIALS] [-v] [-e] [-t] [-l LOGIN] [-p PASSWD] [-cc COMPLETE] [-id IDHAL] json_path

Arguments

• positional argument: json_path Path to the JSON file

• optional arguments:

short	long	default	help
-h	--help		show this help message and exit
-c	--credentials	None	Path to the credentials file
-v	--verbose		Show all logs
-e	--prod		Execute on production server (use with caution)
-t	--test		Execute on prod server as test (dryrun)
-l	--login	None	Username for API (HAL)
-p	--passwd	None	Password for API (HAL)
-cc	--complete	None	Run completion (use grobid, idext or affiliation or list of terms separated by comma)
-id	--idhal	None	idHal to link deposit to specific user

Note that:

• HAL credentials (for production or pre-production server) could be provided using .apihal based on JSON syntax (see .apihal_example)
• by default, the preprod server is used (argument -e use the production server)
• a test mode on production server could be used by give argument -t

Installation

push2HAL could be installed directly from PyPI using pip install push2HAL

In addition, download this repository and run pip install . in the root folder of it.

Examples

Folder Examples contains basic example files such as:

• .apihal_example is a credentials example file that must be edited, renamed as .apihal and located in the current working directory or in the same directory as the argument file for pdf2hal or json2hal.
• file.pdf that can be used with pdf2hal for testing the behavior of the command: pdf2hal file.pdf
• test_comments.json contains a detailed version of the JSON file that can be used with json2hal. It contains all the possible fields of the input JSON file with basic comments. This file can not be used directly with json2hal (use test.json in place).
• test.json is a working JSON file that can be used with json2hal: json2hal test.json.

References

The tools have been developed by considering documentation:

• SWORD implementation in HAL
• XSD validation format for HAL
• XML integration documentation for HAL
• common XML files for HAL
• HAL referential
• HAL API syntax for searching

Todo

• Create xml2hal cli
• Add the possibility to use pdf2hal only for finding HAL id
• Return HAL document ID after creation of a new note