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.9.tar.gz (25.5 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.9-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: data_pipeline_api-0.7.9.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.11.1 Windows/10

File hashes

Hashes for data_pipeline_api-0.7.9.tar.gz
Algorithm Hash digest
SHA256 9049f098866fde0036790bc81a7d3b1b945dd0fe9e1c2d620578aa7f9f46cea9
MD5 478abc71afa3eb526c2803504d76f365
BLAKE2b-256 21cee5ba48e6f148d2b5d5a90247dc86e963f2899704d99a9cc53d1e89d7e0ee

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for data_pipeline_api-0.7.9-py3-none-any.whl
Algorithm Hash digest
SHA256 26708cf32718fad4815a477881f32a356ec7abdf8e364d41618acd621c7a7496
MD5 e07df670f2a5d88b99c2b73f4381280e
BLAKE2b-256 91a7add5d2f0f477fe447fba85c6498bf8e8362455a9a2b2b87bdce83e0c24e3

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