data-pipeline-api


Namedata-pipeline-api JSON
Version 0.7.13 PyPI version JSON
download
home_pagehttps://www.fairdatapipeline.org/
SummaryPython api to interact with the Fair Data Pipeline
upload_time2023-07-08 20:45:44
maintainer
docs_urlNone
authorRyan J Field
requires_python>=3.8,<4.0
licenseGNU General Public License v3.0
keywords fair data pipeline fair data management provenance
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyDataPipeline

[![PyPI](https://img.shields.io/pypi/v/data-pipeline-api)](https://pypi.org/project/data-pipeline-api/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/data-pipeline-api)](https://pypi.org/project/data-pipeline-api/)
[![pyDataPipeline](https://github.com/FAIRDataPipeline/pyDataPipeline/actions/workflows/pyDataPipeline.yaml/badge.svg?branch=dev)](https://github.com/FAIRDataPipeline/pyDataPipeline/actions/workflows/pyDataPipeline.yaml)
[![codecov](https://codecov.io/gh/FAIRDataPipeline/pyDataPipeline/branch/dev/graph/badge.svg?token=Eax5AmrDxx)](https://codecov.io/gh/FAIRDataPipeline/pyDataPipeline)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5562602.svg)](https://doi.org/10.5281/zenodo.5562602)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5461/badge)](https://bestpractices.coreinfrastructure.org/projects/5461)

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/](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](https://www.fairdatapipeline.org/pyDataPipeline/examples/SEIRS.html)

            

Raw data

            {
    "_id": null,
    "home_page": "https://www.fairdatapipeline.org/",
    "name": "data-pipeline-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "FAIR Data Pipeline,FAIR,Data Management,Provenance",
    "author": "Ryan J Field",
    "author_email": "ryan.field@glasgow.ac.uk",
    "download_url": "https://files.pythonhosted.org/packages/40/04/801be7a91e22947d91f88d2e0e94ae7d18a5486d90143bb1b3b3b90f3b3b/data_pipeline_api-0.7.13.tar.gz",
    "platform": null,
    "description": "# pyDataPipeline\n\n[![PyPI](https://img.shields.io/pypi/v/data-pipeline-api)](https://pypi.org/project/data-pipeline-api/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/data-pipeline-api)](https://pypi.org/project/data-pipeline-api/)\n[![pyDataPipeline](https://github.com/FAIRDataPipeline/pyDataPipeline/actions/workflows/pyDataPipeline.yaml/badge.svg?branch=dev)](https://github.com/FAIRDataPipeline/pyDataPipeline/actions/workflows/pyDataPipeline.yaml)\n[![codecov](https://codecov.io/gh/FAIRDataPipeline/pyDataPipeline/branch/dev/graph/badge.svg?token=Eax5AmrDxx)](https://codecov.io/gh/FAIRDataPipeline/pyDataPipeline)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5562602.svg)](https://doi.org/10.5281/zenodo.5562602)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5461/badge)](https://bestpractices.coreinfrastructure.org/projects/5461)\n\nWelcome to pyDataPipeline a Python api to interact with the Fair Data Pipeline.\n\nFull documention of the pyDataPipeline is avaialable at [https://www.fairdatapipeline.org/pyDataPipeline/](https://www.fairdatapipeline.org/pyDataPipeline/)\n\n## Installation\npyDataPipeline can be installed from PyPi:\n```\npip3 install data-pipeline-api\n```\n\nOr from the Repository:\n```\ngit clone https://github.com/FAIRDataPipeline/pythonFDP.git\n\ngit checkout dev\n\npip3 install -e .\n```\n**NB. PyDataPipeline requires Python3.**\n\n## Example submission_script\n\nAssume FDP_CONFIG_DIR, storage_locations and objects have been set by CLI tool\n\n```\nimport os\nimport fairdatapipeline as pipeline\n\ntoken = os.environ['FDP_LOCAL_TOKEN']\nconfig_dir = os.environ['FDP_CONFIG_DIR']\nconfig_path = os.path.join(config_dir, 'config.yaml')\nscript_path = os.path.join(config_dir, 'script.sh')\n\nhandle = pipeline.initialise(token, config_path, script_path)\n\npipeline.finalise(token, handle)\n\n```\n\n## SEIRS Model Example\n\nThe SEIRS Model Example is available at: [https://www.fairdatapipeline.org/pyDataPipeline/examples/SEIRS.html](https://www.fairdatapipeline.org/pyDataPipeline/examples/SEIRS.html)\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3.0",
    "summary": "Python api to interact with the Fair Data Pipeline",
    "version": "0.7.13",
    "project_urls": {
        "Homepage": "https://www.fairdatapipeline.org/",
        "Issue Tracker": "https://github.com/FAIRDataPipeline/pyDataPipeline/issues",
        "Repository": "https://github.com/FAIRDataPipeline/pyDataPipeline"
    },
    "split_keywords": [
        "fair data pipeline",
        "fair",
        "data management",
        "provenance"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bdec21b4d909d4cc0677dab31e133c43e1e7b21d1e059975c65e53e6b07258ef",
                "md5": "0900fc1819886047a5d5e3738621a84d",
                "sha256": "b352d357f5c3a81d03a3d2ed4e9d3d340edb80a86e54caa18053643e0b401b85"
            },
            "downloads": -1,
            "filename": "data_pipeline_api-0.7.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0900fc1819886047a5d5e3738621a84d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 28418,
            "upload_time": "2023-07-08T20:45:42",
            "upload_time_iso_8601": "2023-07-08T20:45:42.095485Z",
            "url": "https://files.pythonhosted.org/packages/bd/ec/21b4d909d4cc0677dab31e133c43e1e7b21d1e059975c65e53e6b07258ef/data_pipeline_api-0.7.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4004801be7a91e22947d91f88d2e0e94ae7d18a5486d90143bb1b3b3b90f3b3b",
                "md5": "b08c2f07079367bebffd85f2006ea861",
                "sha256": "3f6c35fe9767094b5505be07d2d33793a2ad6694c57b10216cb54352de96e292"
            },
            "downloads": -1,
            "filename": "data_pipeline_api-0.7.13.tar.gz",
            "has_sig": false,
            "md5_digest": "b08c2f07079367bebffd85f2006ea861",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 25759,
            "upload_time": "2023-07-08T20:45:44",
            "upload_time_iso_8601": "2023-07-08T20:45:44.012529Z",
            "url": "https://files.pythonhosted.org/packages/40/04/801be7a91e22947d91f88d2e0e94ae7d18a5486d90143bb1b3b3b90f3b3b/data_pipeline_api-0.7.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-08 20:45:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "FAIRDataPipeline",
    "github_project": "pyDataPipeline",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "data-pipeline-api"
}
        
Elapsed time: 0.40314s