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.8.0.tar.gz (35.3 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.8.0-py3-none-any.whl (45.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flowbio-0.8.0.tar.gz
Algorithm Hash digest
SHA256 c398616c903febd0625214e3bdc4ac580e13bdb586d55a5a5f4641dddbddb6ad
MD5 900c1911f2649e6a089bab911d4376e8
BLAKE2b-256 da7acf0fee23d5b144eb3308fde2365fa4ce4b5f322723a953afd8cb7129040a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flowbio-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 45.2 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca26dda5599d17c4ffc5e59c7cdb22e5869c2385cea40942ac489474a526c2aa
MD5 c168f7e6ca5fa28e891257ea598e1ae9
BLAKE2b-256 b217fe4a4e68aff5ed4cff1718f8788679590a0a089e78a22ff11e63858f1b27

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