This repository contains code that retrieves structured research data from two sources: protocols.io, and the OSF. These data are retrieved using the services' respective APIs, parsed into a structured format, and output using a Microsoft Word templating system to a single docx document.
- python 3.8+
pip install requirements.txt
The code is structured as a set of scripts to run in-order. These tools are configured in config.json
.
1_pull_from_protocols.py
--- Connect to protocols.io and retrieve data2_pull_from_osf.py
--- Connect to OSF and retrieve files to a directory. This doesn't currently work due to auth issues, so this script is inoperative.3_merge_into_template.py
--- Render the files and database into a docx file.
- OSF authentication is unreliable so currently files are retrieved from disk
- Templating for MS Word is very limited due to poor library support for the format
This work is licensed under a Creative Commons Attribution 4.0 International License.