/osd2f

Open Source Data Donation Framework

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

Python application Code style: black

OSD2F: Open Source Data Donation Framework

Goal

Use OSD2F to run your own Data Donation service. The aim of this project is to facilitate scientists to collect data donations, by providing an easy-to-use web-based data donation platform. Here, scientists can instruct participants in their research to upload data exports from major online platforms (generally based on participants rights to their own data under GDPR).

Data Donation Packages currently supported in JSON format.

Using OSD2F locally

Installing the OSD2F locally is relatively simple by using pip's support for installation straight from VCS. However, we recommend local installation only in cases in which you want to familiarize yourself with OSD2F and never for production (real data collection) purposes.

Note: There is a different set of instructions for development purposes in the development docs

Installation (not for development)

OSD2F requires python 3.8 or up, check your version by running:

python --version

should say something like:

Python 3.8.0

Note: it's recommended to use a virtual environment, please consult de development docs for more information.

pip install git+https://github.com/uvacw/osd2f

Running

osd2f -h # see help
osd2f -m Testing # to run a testing instance

You can configure the text content of the webpages. The easiest way to get started is by generating a YAML file with the default values and editing it to your liking:

osd2f --generate-current-config config.yaml

You can start the server with this content configuration by passing a file-path via the CLI.

osd2f --content-configuration config.yaml # make sure you've edited it first

Note: OSD2F will store the configuration in the database. In development mode, the most recently edited version is used between the database and the file.

See also:

  1. how to develop
  2. Deploying to Azure
  3. Running stresstests