flowbio

The flowbio Python library is a wrapper around the Flow API, allowing you to easily write Python scripts that interact with an instance of Flow.

Installing

flowbio is available from PyPI:

Install flowbio from PyPI

pip install flowbio

Alternatively you can clone directly from GitHub:

Install flowbio from GitHub

git clone git://github.com/goodwright/flowbio.git

Use

To interact with the Flow API, you must first create a client:

Creating a client

import flowbio
client = flowbio.Client()

By default, flowbio will communicate with the public instance of Flow at https://api.flow.bio/graphql, but you can specify a different endpoint if using a private instance of Flow:

Using a private Flow API

import flowbio
client = flowbio.Client(url="https://api.flow.mycompany.com/graphql")

Authentication

For many operations you will need to interact with the API as an authenticated user. This can be done with the login method:

Authenticating with flowbio

client.login("myusername", "mypassword")

Was this page helpful?