Skip to main content

Python SDK for SRG+

Project description

SRG+ Python SDK

Python client for the SRG+ API — manage hub profiles, channels, contents, assets, workspaces, and permissions.

Installation

pip install srgplus

Requires Python 3.11+ and depends on httpx and pydantic.

Quick start

from srg import SRGClient

with SRGClient(api_key="srgplus_...") as client:
    profiles = client.hub_profiles.list()
    contents = client.contents.filter(profiles[0].id)

The api_key can also be provided via the SRG_API_KEY environment variable:

export SRG_API_KEY=srgplus_...
client = SRGClient()  # reads from env

Async

import asyncio
from srg import AsyncSRGClient

async def main():
    async with AsyncSRGClient(api_key="srgplus_...") as client:
        channels = await client.channels.list(hub_profile_id="hp-id")

asyncio.run(main())

Configuration

Parameter Env var Default
api_key SRG_API_KEY required
timeout 30.0 s

Documentation

Full API reference and usage examples are in docs/:

Section Reference
Client (SRGClient, AsyncSRGClient) docs/client.md
Users docs/resources/users.md
Invitations docs/resources/invitations.md
Permissions docs/resources/permissions.md
Permission Groups docs/resources/permission_groups.md
Hub Profiles docs/resources/hub_profiles.md
Workspaces docs/resources/workspaces.md
Assets docs/resources/assets.md
Channels docs/resources/channels.md
Contents docs/resources/contents.md
Error handling docs/exceptions.md

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

srgplus-0.1.3.tar.gz (89.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

srgplus-0.1.3-py3-none-any.whl (60.1 kB view details)

Uploaded Python 3

File details

Details for the file srgplus-0.1.3.tar.gz.

File metadata

  • Download URL: srgplus-0.1.3.tar.gz
  • Upload date:
  • Size: 89.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for srgplus-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d8d43d28a34838dbbd6929d9e5cf2bc93d1103a6c454d50d00c467926f190902
MD5 a2baa053740eb750b92170611b448010
BLAKE2b-256 804c9a8a003e1432d0d4a855a10e7e15d0a7c5dea3d4fcda28fce6098a74ff0c

See more details on using hashes here.

File details

Details for the file srgplus-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: srgplus-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 60.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for srgplus-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 10a1e24c1f5e474eadca9c13113c3dad1b670e4435cea5f63dd6e9e4e21e99be
MD5 791747bc226be80ac2c5a51a8955e393
BLAKE2b-256 7a19d6c94126f3c2090fe656212ef836e3c0fe3480e220b0a61d0e787e24d55a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page