Installation & Guide

How to Install the Groclake Library

To use the Groclake library in your project, you need to install it using pip. The library is available on the Test PyPI repository. Run the following command in your terminal to install it:

pip install groclake

Prerequisites

Ensure that you have the necessary API credentials for the Groclake service:

• GROCLAKE_API_KEY

• GROCLAKE_ACCOUNT_ID

These should be set as environment variables before making any API requests.

Steps to obtain credentials?

Step 1 : Access the Registration Page: Click here to visit the registration page.

Step 2 : After registering you'll receive a mail on your registered email ID from where you can find the OTP for validation

Step 3 : Fill your OTP

Step 4 : After verifying with OTP, you'll receive an another mail which will consist of your account password for login into your account

Step 5: Now login to your account with the provided password, on homepage look for this CTA which says "Manage Secret Keys" now click on this button

Step 6 : Head on to the button called " Create New secret Key" & click on that

Step 7 : After clicking a side widget will open where you can name your secret key for easy identification & then you can hit on the "Create Secret Key" to create.

Step 8: Now you'll be able to see your "Secret Key" & "Account ID" which will be your groclake_api_key & groclake_account_id

Set Environment Variables

Before interacting with the CatalogLake API, make sure your API key and account ID are set up in your environment.

Python

import os
from groclake.cataloglake import CatalogLake

# Environment variable setup
GROCLAKE_API_KEY = 'your_api_key_here'
GROCLAKE_ACCOUNT_ID = 'your_account_id_here'

os.environ['GROCLAKE_API_KEY'] = GROCLAKE_API_KEY
os.environ['GROCLAKE_ACCOUNT_ID'] = GROCLAKE_ACCOUNT_ID

# Initialize Groclake catalog instance
catalog = CatalogLake()