Client initialization

Good to know: Outlining how updates work will help everyone know how they collaborate with the system, having a robust approach to updating your design system is super important – afterall a design system is never complete!

Install the BagelDB Client

To install the BagelDB client, use the following command in your terminal:

pip install betabageldb

Configure Environment Variables & Initialize the Client

For using privately owned datasets, it's necessary to configure your user_id and api_keys. This allows BagelDB to create isolated data instances for you.

import os
import bagel
from bagel.config import Settings

# Set environment variables (Optional)
os.environ['BAGEL_API_KEY'] = 'your_api_key_here'
os.environ['BAGEL_USER_ID'] = 'your_user_id_here'

# Configure Bagel server settings for production
server_settings = Settings(
    bagel_api_impl="rest",
    bagel_server_host="api.bageldb.ai",
)

# Initialize the Bagel client
client = bagel.Client(server_settings)

# Test server connectivity
print(client.ping())

# Retrieve server version information
print(client.get_version())