flowbio
=======

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

Installation
------------

Install with pip::

    pip install flowbio

Requires Python 3.8+. Dependencies (``requests``, ``pydantic``, ``tqdm``, etc.)
are installed automatically.

Overview
--------

Everything starts with creating a :class:`~flowbio.v2.Client`. This is your
connection to Flow — once you log in, you use it to upload samples, browse
metadata, manage projects, and anything else the library supports::

    from flowbio.v2 import Client
    from flowbio.v2.auth import UsernamePasswordCredentials

    client = Client()
    client.log_in(UsernamePasswordCredentials("you@example.com", "password"))

    # Now use client.samples.upload_sample(...), client.samples.upload_multiplexed_data(...), etc.

The :class:`~flowbio.v2.Client` is the recommended starting point and is
under active development. The :class:`legacy client <flowbio.Client>` is
being phased out but remains available for functionality not yet covered
by v2.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Home <self>
   v2/index
   legacy
   faq