Skip to content

Examples

This chapter contains runnable example scripts that demonstrate common py-homebox workflows.

Each script is self-contained and loads credentials from a .env file in the examples/ directory. Copy examples/.env.sample to examples/.env and fill in your Homebox URL and credentials before running.

Example Description
Get Homebox Statistics Retrieve and print group, label, location, and time-series statistics
Create Location and Add Items Create a location, add items individually and in bulk, and generate a location label
Item Attachments Upload, list, and download file attachments on an item
Get Item Labels Generate printable PNG labels for every item in a location
User Management Create a group invitation and register a new user account