flowbio


Nameflowbio JSON
Version 0.3.2 PyPI version JSON
download
home_pagehttps://github.com/goodwright/flowbio
SummaryA client for the Flow API.
upload_time2023-11-02 02:37:02
maintainer
docs_urlNone
authorSam Ireland
requires_python!=2.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*
licenseMIT
keywords nextflow bioinformatics pipeline
VCS
bugtrack_url
requirements kirjava tqdm
Travis-CI No Travis.
coveralls test coverage No coveralls.
            flowbio
=======

A client for the Flow API.

.. code-block:: python
    
    import flowbio

    client = flowbio.Client()
    client.login("your_username", "your_password")

    # Upload standard data
    data = client.upload_data("/path/to/file.fa", progress=True, retries=5)
    print(data)

    # Upload sample
    sample = client.upload_sample(
        "My Sample Name",
        "/path/to/reads1.fastq.gz",
        "/path/to/reads2.fastq.gz", # optional
        progress=True,
        retries=5,
        metadata={
            "category": "RNA-Seq",
            "strandedness": "unstranded",
        }
    )
    print(sample)

    # Upload multiplexed
    multiplexed = client.upload_multiplexed(
        "/path/to/reads.fastq.gz",
        progress=True,
        retries=5,
    )
    print(multiplexed)

    # Upload annotation
    annotation = client.upload_annotation(
        "/path/to/annotation.csv",
        progress=True,
        retries=5,
    )
    print(annotation)

    # Run pipeline
    execution = client.run_pipeline(
        "RNA-Seq",
        "3.8.1",
        "23.04.3",
        params={"param1": "param2"},
        data_params={"fasta": 123456789},
    )



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/goodwright/flowbio",
    "name": "flowbio",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "!=2.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*",
    "maintainer_email": "",
    "keywords": "nextflow bioinformatics pipeline",
    "author": "Sam Ireland",
    "author_email": "sam@goodwright.com",
    "download_url": "",
    "platform": null,
    "description": "flowbio\n=======\n\nA client for the Flow API.\n\n.. code-block:: python\n    \n    import flowbio\n\n    client = flowbio.Client()\n    client.login(\"your_username\", \"your_password\")\n\n    # Upload standard data\n    data = client.upload_data(\"/path/to/file.fa\", progress=True, retries=5)\n    print(data)\n\n    # Upload sample\n    sample = client.upload_sample(\n        \"My Sample Name\",\n        \"/path/to/reads1.fastq.gz\",\n        \"/path/to/reads2.fastq.gz\", # optional\n        progress=True,\n        retries=5,\n        metadata={\n            \"category\": \"RNA-Seq\",\n            \"strandedness\": \"unstranded\",\n        }\n    )\n    print(sample)\n\n    # Upload multiplexed\n    multiplexed = client.upload_multiplexed(\n        \"/path/to/reads.fastq.gz\",\n        progress=True,\n        retries=5,\n    )\n    print(multiplexed)\n\n    # Upload annotation\n    annotation = client.upload_annotation(\n        \"/path/to/annotation.csv\",\n        progress=True,\n        retries=5,\n    )\n    print(annotation)\n\n    # Run pipeline\n    execution = client.run_pipeline(\n        \"RNA-Seq\",\n        \"3.8.1\",\n        \"23.04.3\",\n        params={\"param1\": \"param2\"},\n        data_params={\"fasta\": 123456789},\n    )\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A client for the Flow API.",
    "version": "0.3.2",
    "project_urls": {
        "Homepage": "https://github.com/goodwright/flowbio"
    },
    "split_keywords": [
        "nextflow",
        "bioinformatics",
        "pipeline"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3d884956bff76d58d98adbb52bd218d5e204098743d00edac9d7204339f946c4",
                "md5": "06c88378c7697bded01a1c98f63aa570",
                "sha256": "2479601fc01bdacce0a7480a160bceb48835733586b6a6a48c170aaffc1c589e"
            },
            "downloads": -1,
            "filename": "flowbio-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "06c88378c7697bded01a1c98f63aa570",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "!=2.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*",
            "size": 8230,
            "upload_time": "2023-11-02T02:37:02",
            "upload_time_iso_8601": "2023-11-02T02:37:02.241900Z",
            "url": "https://files.pythonhosted.org/packages/3d/88/4956bff76d58d98adbb52bd218d5e204098743d00edac9d7204339f946c4/flowbio-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-02 02:37:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "goodwright",
    "github_project": "flowbio",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "kirjava",
            "specs": [
                [
                    "==",
                    "0.4.0"
                ]
            ]
        },
        {
            "name": "tqdm",
            "specs": []
        }
    ],
    "lcname": "flowbio"
}
        
Elapsed time: 0.21143s