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 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.6-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for data_pipeline_api-0.7.6.tar.gz
Algorithm Hash digest
SHA256 a30b79c8f58a14a648a07e6ec3f47c5354ae42e5d8041d87ed1ab34eff3b4050
MD5 7a987c73fef9de74061f5353b8646000
BLAKE2b-256 6fe4ea1f38e2927fe27bc3dbae8fbfe9359e516867275037852f04acf6aaf1b7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for data_pipeline_api-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c6d51d22f524caca6d56c9c4fa3240df48a973ed260e3e4d8fe7583235548905
MD5 8fe2783a9168fb681d1ebac7bce40a85
BLAKE2b-256 19444dffabdd94df4181de4ed5ed81b2f7f0c3dc9adafa1f143e0762f22a31d5

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