Skip to main content

Async HTTP + WebSocket client for Social Home, used by the Home Assistant integration.

Project description

socialhome-client

Async HTTP + WebSocket client for Social Home, published to PyPI as socialhome-client and consumed by the Home Assistant integration.

Never imports from social_home (core). Safe to install inside Home Assistant Core, which runs on Python 3.13.

Install

pip install socialhome-client

Use

The client groups methods under feature resources — e.g. c.me.get(), c.shopping.add(...), c.bot.create(...) — rather than a flat surface.

import asyncio

from socialhome_client import SocialHomeClient, SocialHomeWsManager


async def main() -> None:
    async with SocialHomeClient("http://homeassistant.local:8099", token="…") as sh:
        me = await sh.me.get()
        print(me.display_name)

        await sh.shopping.add("milk")
        events = await sh.calendar.list_events("cal-1", "2026-05-01", "2026-06-01")
        print(f"{len(events)} events this month")

        ws = SocialHomeWsManager(sh)
        await ws.connect()
        ws.register(
            ["post_created"],
            lambda frame: asyncio.sleep(0, print(frame)),
        )


asyncio.run(main())

Bots

Home Assistant automations can post into a space feed through the bot-bridge. Each bot has its own Bearer token (shown once on create) and posts render with the bot's icon + name instead of a generic "Home Assistant" avatar.

# Admin turns on bot posting for the space, then registers a household bot.
await sh.space.update(space_id, bot_enabled=True)
bot = await sh.bot.create(
    space_id, scope="space", slug="doorbell",
    name="Doorbell", icon="🔔",
)

# Persist bot.token somewhere safe — the backend will not show it again.
await sh.bot.post(
    space_id, bot.token,
    title="Ring", message="Front door",
)

Develop

pip install -e .[dev]
pre-commit install
pytest

License

Mozilla Public License 2.0.

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

socialhome_client-2026.4.24.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

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

socialhome_client-2026.4.24-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file socialhome_client-2026.4.24.tar.gz.

File metadata

  • Download URL: socialhome_client-2026.4.24.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for socialhome_client-2026.4.24.tar.gz
Algorithm Hash digest
SHA256 73eaf1aaef9f5131fcaebbfeb88ecc978498fc0c48283774c79e6a2aa4d6ac06
MD5 4f2ed58f700c62d700b81e1447e8e8b1
BLAKE2b-256 ff00a5bd7de4f8b857c8ad7547d3482825e73cfe75bd7e5a53f70975d615028e

See more details on using hashes here.

Provenance

The following attestation bundles were made for socialhome_client-2026.4.24.tar.gz:

Publisher: publish.yml on social-home-io/socialhome-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file socialhome_client-2026.4.24-py3-none-any.whl.

File metadata

File hashes

Hashes for socialhome_client-2026.4.24-py3-none-any.whl
Algorithm Hash digest
SHA256 da1e74dc31af88db780aa30f295665940a6636bcdd0f2ddfbd91b23d064f70b8
MD5 f361803c175aedb263d8234a1bd31f34
BLAKE2b-256 a0175a8a8a67d56f7fdaffbcce67e5a4f005e67064665c259ace734444a9d51f

See more details on using hashes here.

Provenance

The following attestation bundles were made for socialhome_client-2026.4.24-py3-none-any.whl:

Publisher: publish.yml on social-home-io/socialhome-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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