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.2.tar.gz (18.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.5.2-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flowbio-0.5.2.tar.gz
  • Upload date:
  • Size: 18.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.5.2.tar.gz
Algorithm Hash digest
SHA256 6bd8a834d75f9c17e938a57e9dd70b9ad37825fd530ac65fac93c04f7816d743
MD5 b7fd13bb09860c911976ffc4dfaa47e6
BLAKE2b-256 ce00c2e9dc0652386f1e9a7a728454a1efaed8359c0eb490117e5d44898d32ce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flowbio-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 21.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ec569dc0041c757e044b30ad189952a9aeb4425672f86c9bd79cc84a5c3f624d
MD5 698ab2277fc2c6711f6605b6328cf5ac
BLAKE2b-256 a67360e3fa0a77a081f7ab8975c490983410f45aac3f11e7684df23283dbefd1

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