# flowbio
A client for the Flow API.
```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={
"sample_type": "RNA-Seq",
"scientist": "Charles Darwin",
"type_specific_metadata": '{"strandedness": "reverse"}',
}
)
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": null,
"docs_url": null,
"requires_python": "!=2.*,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*",
"maintainer_email": null,
"keywords": "nextflow bioinformatics pipeline",
"author": "Sam Ireland",
"author_email": "sam@goodwright.com",
"download_url": null,
"platform": null,
"description": "# flowbio\n\nA client for the Flow API.\n\n```python\n \nimport flowbio\n\nclient = flowbio.Client()\nclient.login(\"your_username\", \"your_password\")\n\n# Upload standard data\ndata = client.upload_data(\"/path/to/file.fa\", progress=True, retries=5)\nprint(data)\n\n# Upload sample\nsample = 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 \"sample_type\": \"RNA-Seq\",\n \"scientist\": \"Charles Darwin\",\n \"type_specific_metadata\": '{\"strandedness\": \"reverse\"}',\n }\n)\nprint(sample)\n\n# Upload multiplexed\nmultiplexed = client.upload_multiplexed(\n \"/path/to/reads.fastq.gz\",\n progress=True,\n retries=5,\n)\nprint(multiplexed)\n\n# Upload annotation\nannotation = client.upload_annotation(\n \"/path/to/annotation.csv\",\n progress=True,\n retries=5,\n)\nprint(annotation)\n\n# Run pipeline\nexecution = 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\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A client for the Flow API.",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/goodwright/flowbio"
},
"split_keywords": [
"nextflow",
"bioinformatics",
"pipeline"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b8454d4923eee9e08a121a82dad7a2c15850276103df1eb93c5d3f00368ee06",
"md5": "216afc5066802ff71eb652bfaabd5470",
"sha256": "4c8377ae019e552a3415111afd12fba5f1fb0ca4aa903c850adfb3ae29c01364"
},
"downloads": -1,
"filename": "flowbio-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "216afc5066802ff71eb652bfaabd5470",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "!=2.*,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*",
"size": 8335,
"upload_time": "2024-12-14T02:18:33",
"upload_time_iso_8601": "2024-12-14T02:18:33.164336Z",
"url": "https://files.pythonhosted.org/packages/6b/84/54d4923eee9e08a121a82dad7a2c15850276103df1eb93c5d3f00368ee06/flowbio-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 02:18:33",
"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"
}
JSON
