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.6.0.tar.gz (29.5 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.6.0-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flowbio-0.6.0.tar.gz
Algorithm Hash digest
SHA256 29f643a4628cdaf795e4ab28754cbc81434311c2ea870dd0de707bd1d1f1d84f
MD5 d23deac9a17a9fa883913bbaca8e225c
BLAKE2b-256 91848ad149e12fa86ab3d447e951103c752e6b8bbb606cf79dab2d90463f60be

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flowbio-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 38.9 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4ccf8027c1feeb04fd9b83f5ef6090d78e3ca0eb38a86f29f4356806bc854a6
MD5 cee56a85373b414e9d977cdbe85efe04
BLAKE2b-256 5deb6b610e419c1c1b763868bc6038339b9bc90cf889437d2e2d4fa995bc5a66

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