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

Uploaded Python 3

File details

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

File metadata

  • Download URL: data_pipeline_api-0.7.10.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.10.tar.gz
Algorithm Hash digest
SHA256 fd24bda72a97d97d0f84f24d80f89e9d0012616dc7edbc5769edb3ddef0a600d
MD5 780169083d9085f861d2f8c97a7f1132
BLAKE2b-256 ef0e5a619caa7df86aa61bb4fac1dafdf215eaf95fcba7d56eff235c23d0c52d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for data_pipeline_api-0.7.10-py3-none-any.whl
Algorithm Hash digest
SHA256 cfe4bc02c559e4503cee8ec9923f334b022ab0a7b3b3f97293fc2c753d483f5e
MD5 f43f265a6f37153b2399636d31da5383
BLAKE2b-256 df4d083ac55a7d6932b6c768d2d2f2e944167f1a6843e070f9358b3e9edc9649

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