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.8.tar.gz (26.1 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.8-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: data_pipeline_api-0.7.8.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.15 Darwin/21.6.0

File hashes

Hashes for data_pipeline_api-0.7.8.tar.gz
Algorithm Hash digest
SHA256 2fed637f5d4b07d64304924089173e3a9228b7fc79cde0762fb0b4c95a6286de
MD5 8485ed29be8f5b960be88f4e2cef0a67
BLAKE2b-256 1fa12f28c948021839672ad086227732f4cc1b9b78e6822ceaf6f30b4d3bb47c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: data_pipeline_api-0.7.8-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.15 Darwin/21.6.0

File hashes

Hashes for data_pipeline_api-0.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b9c4d847be7dccd634e6e687aae5e80830d2f96f3ec23ab28ee82664de4ac818
MD5 758eb64a840233a5b1dadc8409ebd7a3
BLAKE2b-256 579a870bff41deb1068e1da66f05c150cd6ab38dadc9c223f25d5d3d11b523f5

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