Skip to main content

A client for the Flow API.

Project description

flowbio

A client for the Flow API. Full documentation is available at https://goodwright.github.io/flowbio/.

    
import flowbio

# NB: this client is being deprecated. Please use the v2 client instead. See the [v2 documentation](https://goodwright.github.io/flowbio/v2/) for details.
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},
)

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

flowbio-0.5.3.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flowbio-0.5.3-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file flowbio-0.5.3.tar.gz.

File metadata

  • Download URL: flowbio-0.5.3.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for flowbio-0.5.3.tar.gz
Algorithm Hash digest
SHA256 b85a13a150834aa695a9454b774d7ee27df3a042f4c39a5dce6246985326102c
MD5 b7bf3109e76316e5d5b16f64ede5c9e2
BLAKE2b-256 45eb27f63bd42a8a95bf47bee8d9dd520373efaba07bee763a174050b4e31a93

See more details on using hashes here.

File details

Details for the file flowbio-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: flowbio-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for flowbio-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4e120d39ee7577335c6990699605220d3b2614e5264c15e40bab4ca0c68047c6
MD5 906dae61115e12a3bebc0405c84335ab
BLAKE2b-256 475f96b6609492c6cc3292a6742bd060a5b524166365e7752e7ebe792c24dd2c

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