Skip to content
Branch: master
Clone or download

README.md

Rubrik SDK for Python

master devel
Master Branch Status Devel Branch Status

This project provides a Python package that makes it easy to interact with the Rubrik CDM API.

The SDK has been tested against Python 2.7.6 and Python 3.6.4.

🔨 Installation

Install from pip:

pip install rubrik_cdm

Install from source:

$ git clone https://github.com/rubrikinc/rubrik-sdk-for-python
$ cd rubrik-sdk-for-python
$ python setup.py install

🔍 Example

By default, the Rubrik SDK will attempt to read the the Rubrik Cluster credentials from the following environment variables:

  • rubrik_cdm_node_ip
  • rubrik_cdm_username
  • rubrik_cdm_password
  • rubrik_cdm_token
Note: The rubrik_cdm_username and rubrik_cdm_password must be supplied together and may not be provided if the rubrik_cdm_token variable is present
import rubrik_cdm
rubrik = rubrik_cdm.Connect()

cluster_version = rubrik.cluster_version()

print(cluster_version)

📘 Documentation

Here are some resources to get you started! If you find any challenges from this project are not properly documented or are unclear, please raise an issue and let us know! This is a fun, safe environment - don't worry if you're a GitHub newbie! ❤️

💪 How You Can Help

We glady welcome contributions from the community. From updating the documentation to adding more functions for Python, all ideas are welcome. Thank you in advance for all of your issues, pull requests, and comments! ⭐️

📌 License

👉 About Rubrik Build

We encourage all contributors to become members. We aim to grow an active, healthy community of contributors, reviewers, and code owners. Learn more in our Welcome to the Rubrik Build Community page.

We'd love to hear from you! Email us: build@rubrik.com 💌

You can’t perform that action at this time.