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

Uploaded Python 3

File details

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

File metadata

  • Download URL: data_pipeline_api-0.7.13.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.13.tar.gz
Algorithm Hash digest
SHA256 3f6c35fe9767094b5505be07d2d33793a2ad6694c57b10216cb54352de96e292
MD5 b08c2f07079367bebffd85f2006ea861
BLAKE2b-256 4004801be7a91e22947d91f88d2e0e94ae7d18a5486d90143bb1b3b3b90f3b3b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: data_pipeline_api-0.7.13-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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 b352d357f5c3a81d03a3d2ed4e9d3d340edb80a86e54caa18053643e0b401b85
MD5 0900fc1819886047a5d5e3738621a84d
BLAKE2b-256 bdec21b4d909d4cc0677dab31e133c43e1e7b21d1e059975c65e53e6b07258ef

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