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.7.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

data_pipeline_api-0.7.7-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

Details for the file data_pipeline_api-0.7.7.tar.gz.

File metadata

  • Download URL: data_pipeline_api-0.7.7.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.4 Windows/10

File hashes

Hashes for data_pipeline_api-0.7.7.tar.gz
Algorithm Hash digest
SHA256 5cf7325470aa8c6c24fdca434ceca30a0bf4a7339f9feede3642d7e42d020e65
MD5 52f1d707b2cf4ccc116f9b6b3fc1273c
BLAKE2b-256 64e4c69eeee73b9dbb24295ecbf337292bd84b7269abcd94ba54342408e617ab

See more details on using hashes here.

File details

Details for the file data_pipeline_api-0.7.7-py3-none-any.whl.

File metadata

  • Download URL: data_pipeline_api-0.7.7-py3-none-any.whl
  • Upload date:
  • Size: 28.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.4 Windows/10

File hashes

Hashes for data_pipeline_api-0.7.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2cca4c59306583f0ade9bf166e73f5b4bb318240847a6d23fe450d3596a95b66
MD5 0e062f9b323d4fc9e1ed312ecb554e6f
BLAKE2b-256 8f48a8558ff81ee96af60a2d7ba9532a9027cb987272d0e65822ada16645eb8f

See more details on using hashes here.

Supported by

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