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
Metadata
1 maintainer
Release files for slurpit_sdk 0.9.156
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| slurpit_sdk-0.9.156.tar.gz | 34.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| slurpit_sdk-0.9.156-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 92.3 kB
Release files / slurpit_sdk-0.9.156.tar.gz
| Download URL | slurpit_sdk-0.9.156.tar.gz |
|---|---|
| Size | 34.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6295773c62cb550933349a973042c5a7e68af7dc768c3ce468e3cbb8f3ad5a48
|
|
BLAKE2b-256 checksum How to use checksums |
e01cc5e356b7613d66feb203eb7afd197d5ba4b89fb7a45f6f79e7bc47a5ee48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.14.8 Linux/6.8.0-139-generic
|
Release files / slurpit_sdk-0.9.156-py3-none-any.whl
| Download URL | slurpit_sdk-0.9.156-py3-none-any.whl |
|---|---|
| Size | 58.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2d3d43443f08d2866eac1c38928bc1d4525aca670f34a15d3613a25c5c7d76e6
|
|
BLAKE2b-256 checksum How to use checksums |
9e24ac53fc34265eabf6f4bf2af2c7cfba1c0a08bb6d88a27f990b66ab9ff39d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.14.8 Linux/6.8.0-139-generic
|
