About Libra

Installing Libra

There are several ways to begin working with the API. Below, a step-by-step guide to different options are highlighted. If you're already familiar with python and PyPi, feel free to skip ahead and just do

pip install libra

Setting up your local enviroment

Install Python 3.6+ directly onto your local machine. Anything lower then 3.6 WILL not work.
For Libra, and other libraries, pip is the best option for installing libraries. Install the most recent version.
If you're looking for an IDE we reccomend installing PyCharm
You should now be able to do pip install libra in your terminal. If you want to setup a local enviroment, follow this guide and then run the command.

Work in an online preconfigured enviroment

We recommend using Google Collaboratory, as it supports intensive processing and configures an enviroment for you.

Make sure you have a google account and open up a notebook in collab.
Use !pip install libra to get all the package information

Understanding the API's structure

There's two structural principles that a user should understand about libra

Everything is built around the client object. You can call different queries on it and everything will be stored under the models field of the object.
You can access all the information as a dictionary. Doing client_object.models['svm'] gets you all the information generated for the svm query.
Your latest model called will automatically be the default. If you call client_object.plots() and don't specify a model, the model for the most recent query that you've called WILL be used. Currently only one model of each type is supported by libra.