https://github.com/secnex/shifiq-sdk-python
https://github.com/secnex/shifiq-sdk-python
digital-signage python python-sdk sdk shifiq
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/secnex/shifiq-sdk-python
- Owner: SecNex
- License: mit
- Created: 2024-11-14T21:04:04.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-15T15:32:53.000Z (11 months ago)
- Last Synced: 2025-01-01T23:18:59.629Z (9 months ago)
- Topics: digital-signage, python, python-sdk, sdk, shifiq
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shifiq API Client for Python
This is a Python client for the ShifIQ API. It allows you to interact with the ShifIQ API to manage your players and their configurations and more.
## Installation
```bash
pip install shifiq-api-client
```
## Usage
```python
from shifiq.api.player import Player, PlayerConfiguration
from shifiq.api.location import Location, LocationGroup, LocationConfiguration, LocationGroupConfiguration
from shifiq.client import ApiClient
client = ApiClient(api_key="your_api_key")
player = Player(client)
location = Location(client)
location_group = LocationGroup(client)
# Player
player.get_all_players()
player.get_player(player_id="123")
player.get_player_by_unique_name(unique_name="unique_name")
# Location
location.get_all_locations()
location.get_location(location_id="123")
location.get_location_by_unique_name(unique_name="unique_name")
# Location Group
location_group.get_all_location_groups()
location_group.get_location_group(location_group_id="123")
location_group.get_location_group_by_unique_name(unique_name="unique_name")
```