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.2.tar.gz (85.2 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.2-py3-none-any.whl (56.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: srgplus-0.1.2.tar.gz
  • Upload date:
  • Size: 85.2 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.2.tar.gz
Algorithm Hash digest
SHA256 f3d3af513e381bce860ea814ec9c1a3b37066f4668d25c1d4c68030778f78da8
MD5 857a879e997dbd6f961271e97e9e09d6
BLAKE2b-256 53ddd385e215f5a12066ae6979f6cc0a568eb6e8c221771dd782ca017a7ab789

See more details on using hashes here.

File details

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

File metadata

  • Download URL: srgplus-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 56.9 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f0b3590d9739bc3ef7ca24e944486e98516f735808ba8b0adb8f61e856a558b5
MD5 4f1ce612d38e4bc18689b130edf06a34
BLAKE2b-256 b605570c0c1559003a124c3190a418a5ca5b075e040a73edb7cac6b63d771b70

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