envbee-sdk 1.7.0

envbee SDK for Python

envbee SDK

envbee SDK is a Python client for interacting with the envbee API (see https://envbee.dev). This SDK provides methods to retrieve variables and manage caching for improved performance.

Table of Contents

• Installation
• Usage
• Methods
• Testing
• License

Installation

To install the envbee SDK, use pip:

pip install envbee-sdk

Usage

To use the envbee SDK, instantiate the envbee class with your API credentials:

from envbee_sdk.main import Envbee

eb = Envbee(api_key="your_api_key", api_secret=b"your_api_secret")

# Retrieve a variable
value = eb.get("VariableName")

# Retrieve multiple variables
variables, metadata = eb.get_variables()

Logging

The root logger name is "envbee_sdk". You can configure the default logging level for the SDK and handle logs as needed. Here's an example of how to set up basic logging for your application using the SDK:

# Basic logging configuration for your application
logging.basicConfig(
    level=logging.ERROR,  # Set default log level for the root logger
    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
    handlers=[logging.StreamHandler()],  # Send logs to stdout
)

# Get the SDK logger (specific to envbee_sdk)
sdk_logger = logging.getLogger("envbee_sdk")
sdk_logger.setLevel(logging.DEBUG)  # You can set the SDK logger to DEBUG for detailed logs

# Example usage within the SDK
sdk_logger.debug("This is a debug message from the SDK.")
sdk_logger.info("Informational message from the SDK.")

Methods

get(variable_name: str) -> any

Fetches the value of a variable by its name. If the API request fails, it retrieves the value from the cache.

get_variables(offset: int = None, limit: int = None) -> tuple[list[dict], Metadata]

Fetches a list of variables from the API with optional pagination parameters.

Caching

The SDK uses a local cache to store variable values as a failsafe mechanism. The cache is updated with each successful endpoint request and serves as a fallback when the network or Internet connection is temporarily unavailable. Currently, the data is stored unencrypted, but encryption will be implemented in future releases.

API Documentation

For more details on the available API endpoints and their usage, check the official API docs.

License

This project is licensed under the MIT License. See the LICENSE file for details.