# ok, API

Official branch (master)

To help people maximize the extensibility and automation capability of Seven Bridges products, we're happy to share example API code. ok, API contains examples have been used to address common user wants and needs. They are divided into recipes & tutorials.

• "How do I do this one thing?" You want a recipe, which is a modular example of common operations.
• "How do I complete my entire analysis?" You want a tutorial, which may combine multiple recipes to go from start to finish of an analysis.

The recipe and tutorial folders in this repository are subdivided into CGC (the Cancer Genomics Cloud) and SBPLAT (the Seven Bridges Platform). This separation ensures we link to the appropriate docs.

---

NOTE

The recipes and tutorials in the CGC folders are not actively maintained. Please refer to the SBPLA folder for latest recipes.

---

Switching between environments is as easy as choosing a different authentication token and API endpoint or a different profile from the sevenbridges credentials file (explained here). Feedback and improvements are welcome.

Background

This repository mainly covered the Seven Bridges Plaform and the Cancer Genomics Cloud Platform, but the recipes and tutorials are applicable to any other installation of the Seven Bridges Platform (the EU platform, the Cavatica Platform, the BioDataCatalyst Powered by Seven Bridges Platform and others). To learn more, see the respective platform documentation.

• The Seven Bridges Platform documentation is at docs.sevenbridges.com. In particular, see the API documentation.
• The Cancer Genomics Cloud documentation is at docs.cancergenomicscloud.com. In particular, see the API documentation.
• The Cavatica platform documentation is at docs.cavatica.org/docs/getting-started.
• The BioDataCatalyst powered by Seven Bridges platform documentation is at https://sb-biodatacatalyst.readme.io/docs

Notes

1. This is compatible with Python 3.6+.
2. This is in beta and we are constantly working on improving our examples. Expect the awesomeness to continue.
3. We are happy to recieve Pull Requests with your improvements or Issues which we will fix asap.

Good luck, have fun!