1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
# FlumeDeviceList
## Overview
FlumeDeviceList is a Python class designed to retrieve the Flume device list from the Flume API. It leverages the authentication handled by FlumeAuth and provides an interface to access the list of devices associated with the user account.
## Dependencies
- requests
## Initialization
To initialize the FlumeDeviceList object, you'll need the following parameters:
- `flume_auth`: FlumeAuth object for authentication.
- `http_session`: (Optional) Requests Session() object.
- `timeout`: (Optional) Requests timeout for throttling. The default value is specified in DEFAULT_TIMEOUT.
## Methods
Device Retrieval
`get_devices()`
Method to return all available devices from the Flume API. This method fetches the JSON device list.
Example
```python
import pyflume
auth = pyflume.FlumeAuth(
username='your_username',
password='your_password',
client_id='client_id',
client_secret='client_secret'
)
auth.retrieve_token()
device_list_obj = pyflume.FlumeDeviceList(
flume_auth=auth
)
device_list = device_list_obj.get_devices()
print(device_list) # Prints the JSON device list
```
|
