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.7.0.tar.gz (30.9 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.7.0-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flowbio-0.7.0.tar.gz
Algorithm Hash digest
SHA256 d5896eb70323ba82084f5b43c395f05a640f64efc8a6247f27906e1f45786b59
MD5 753cd28fbb9188c210a8b7b42f9ee736
BLAKE2b-256 6e778c8a2e03ec46116ab9dc942634fe449080abf408ed41d3ba71d90102cd18

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flowbio-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 40.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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4289088b945f0acafe2db6297dc499f4e2b510b1570074722c05149c8a935ff
MD5 2b6d2fff3c233b564a6a779dae07d0dc
BLAKE2b-256 b8fedd3b8f76f367a10597fe98380c4694c79ddc3f84a3df5706edfbb44f599c

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