Skip to content

Getting started

Getting Started with the Cirro client library

Install

You can install the Cirro client library by running the following

pip install cirro

or

pip install git+https://github.com/CirroBio/Cirro-client.git

Authenticating with your Data Portal log in

Before you use the Cirro CLI, you will need to authenticate yourself. You can do this by running the command below. If the package cannot already find your information (i.e. you or your machine do not have credentials already saved), then this command it will give you a link to log in through a browser window, the same way you would log into the Data Portal website.

from cirro import DataPortal

portal = DataPortal()

That's it! You're now ready to start accessing the Data Portal directly