beamdust-sdk 1.0.0

A Python SDK for interacting with Beamdust API

Beamdust Package

Beamdust is a Python SDK for interacting with APIs that use Swagger specifications. It dynamically generates methods for API endpoints and allows users to perform authenticated API requests with ease.

Installation

You can install the beamdust-package by following these steps:

Clone the repository:

git clone https://github.com/Beamdust/beamdust-package.git

Navigate to the project directory:

cd beamdust-package

Install the package using setup.py:

python setup.py install

This will install the package and its dependencies on your system.

Usage Example

Here's a simple example of how to use the Beamdust SDK to interact with an API:

Import the Beamdust SDK

from beamdust import Beamdust

# Initialize the Beamdust instance
beamdust = Beamdust(base_url="https://your-api.com", email="[e-mail]", password="your-password")

# Retrieve information about available API methods
available_methods = beamdust.get_available_functions()
print("Available API methods:", available_methods)

# Getting the example body to send to this endpoint 
print(beamdust.retrieve_notifications(_help=True))

# Making a request to a dynamically generated API method
notification_response = beamdust.retrieve_notifications({
    "page": 0,
    "size": 2,
    "sorts": {"field": "body.timestamp", "order": "desc"},
    "filters": []
})

Key Features:

Dynamic Method Generation: Methods are automatically generated based on the Swagger documentation of the API. Authentication: Log in using your email and password, and the SDK will manage your authentication token. Swagger Integration: The SDK loads and integrates with Swagger documentation to provide structured access to API endpoints. API Calls: Make API requests to any endpoint by using the method name corresponding to the Swagger operationId. Documentation: Use the _help flag in any method to retrieve the expected body structure for API requests.