Slurpit SDK
The Slurpit SDK is a Python package for interacting with the Slurpit API, enabling developers to easily manage devices and planning resources. It is designed for simplicity and flexibility, offering methods for listing devices, retrieving planning data, and exporting information to CSV format.
Installation
Install the SDK:
pip install slurpit_sdk
To run the examples, install dependencies using Poetry (recommended):
poetry install
Alternatively, use pip:
pip install -r requirements.txt
To build from source:
cd src
python setup.py install
Quick Start
To quickly test the examples, copy .env.example to .env (includes default sandbox credentials):
# From the examples/ folder run:
cp .env.example .env
Working with Devices
Retrieve and print the hostnames of all devices:
devices = api.device.get_devices()
for device in devices:
print(device.hostname)
Exporting Data to CSV
To export planning data to a CSV file:
plannings_csvdata = api.planning.get_plannings(export_csv=True)
result = api.device.save_csv_bytes(plannings_csvdata, "csv/plannings.csv")
Exporting Data as Pandas DataFrame
To export planning data as a pandas dataframe
plannings_df = api.planning.get_plannings(export_df=True)
Pagination
Handle large sets of devices with pagination:
devices = api.device.get_devices(offset=100, limit=1000)
for device in devices:
print(device.hostname)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file slurpit_sdk-0.9.146.tar.gz.
File metadata
- Download URL: slurpit_sdk-0.9.146.tar.gz
- Upload date:
- Size: 34.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.14.6 Linux/6.8.0-124-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6c964d6d07bfd149fa2f51b69cc1df63eb323aed576856c38e028bcad9af29f4
|
|
| MD5 |
f170c6df4d6dc20c0ff7e01d6c9535eb
|
|
| BLAKE2b-256 |
62764292e237f3a5c26ab23bc07b774f42d0c8ac54a1d4bd54b0db5b6ffe66ab
|
File details
Details for the file slurpit_sdk-0.9.146-py3-none-any.whl.
File metadata
- Download URL: slurpit_sdk-0.9.146-py3-none-any.whl
- Upload date:
- Size: 57.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.14.6 Linux/6.8.0-124-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96b33e7e52538a1f79cc62cca3d2e688b7a4e8d5cb350f91c9087c0cc5f8a174
|
|
| MD5 |
e30deecc895967df3f569ca22b57e902
|
|
| BLAKE2b-256 |
23348bd5ba464a6041deb2542035c35fd900f4dc70c321ea9b82b5069e41b8d4
|
