Skip to main content

Python api to interact with the Fair Data Pipeline

Project description

pyDataPipeline

PyPI PyPI - Python Version 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.12.tar.gz (25.8 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.12-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: data_pipeline_api-0.7.12.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Darwin/22.5.0

File hashes

Hashes for data_pipeline_api-0.7.12.tar.gz
Algorithm Hash digest
SHA256 90a140678bc4189601704b8f5fc38a9e27da98d40ecc77fa5989b1d342f90df4
MD5 bb8111153e00e1afa00c291970e2fff5
BLAKE2b-256 322002644ebfd01113f730769ed14557ce6b915a311c8a07930b971b6cf91ac7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: data_pipeline_api-0.7.12-py3-none-any.whl
  • Upload date:
  • Size: 28.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Darwin/22.5.0

File hashes

Hashes for data_pipeline_api-0.7.12-py3-none-any.whl
Algorithm Hash digest
SHA256 d2d2573a5328c197555e85448c45df2e5a406625320d36a43142792935f254e1
MD5 ed1bf7f53cdaa24dc2cc4f36fff34335
BLAKE2b-256 23ea555d9453bf983fe7fc28af1074bdb8a4fa32e8c9a48f0bb44366566d4043

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