BCL-Examples

Storehouse of Scripts to share with our API customers to assist with their interactions with BCL Orders

Setting up your environment

This repository uses python. You can find instructions on installing python and setting up a virtual environment here

There are also a few dependencies that need to be installed with pip. You can find instruction on installing those dependencies here

Token Generation

In common/obtain_token.py we generate our valid token and session for all the other requests we make in this library. We have 3 ways to generate a valid authorized session.

• Service Account Impersonation: Uses the email of a service account to generate the credentials.
• Credentials File: Uses a saved credentials file on the current system to generate the credentials.
• Google Compute: Uses the Google Compute Engine to generate the credentials.

By default the file uses Service Account Impersonation, but this can be changed to fit your needs.

BCL Orders Library

This library contains code for accessing BCL Orders API endpoints and performing some operations such as creating an order. You can find more information here

Terra Data Repository (TDR) Library

This library contains our code for accessing TDR API Endpoints and performing operations involving snapshots. You can find more information here

End to End Example

The files extract_files_in_tdr_snapshot_from_snapshot_id.py and place_order_and_manipulate_status.py are examples of using the libraries end to end from placing and retrieving data from GPO to modifying statuses and extracting results from TDR.