Skip to main content

Python api to interact with the Fair Data Pipeline

Project description

pyDataPipeline

pyDataPipeline codecov DOI CII Best Practices

Welcome to pyDataPipeline a Python api to interact with the Fair Data Pipeline.

Full documention of the pyDataPipeline is avaialable at https://www.fairdatapipeline.org/pyDataPipeline/

Installation

pyDataPipeline can be installed from PyPi:

pip3 install data-pipeline-api

Or from the Repository:

git clone https://github.com/FAIRDataPipeline/pythonFDP.git

git checkout dev

pip3 install -e .

NB. PyDataPipeline requires Python3.

Example submission_script

Assume FDP_CONFIG_DIR, storage_locations and objects have been set by CLI tool

import os
import fairdatapipeline as pipeline

token = os.environ['FDP_LOCAL_TOKEN']
config_dir = os.environ['FDP_CONFIG_DIR']
config_path = os.path.join(config_dir, 'config.yaml')
script_path = os.path.join(config_dir, 'script.sh')

handle = pipeline.initialise(token, config_path, script_path)

pipeline.finalise(token, handle)

SEIRS Model Example

The SEIRS Model Example is available at: https://www.fairdatapipeline.org/pyDataPipeline/examples/SEIRS.html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

data_pipeline_api-0.7.6.tar.gz (26.0 kB view hashes)

Uploaded Source

Built Distribution

data_pipeline_api-0.7.6-py3-none-any.whl (28.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page