houndapi.client package

Subpackages

• houndapi.client.methods package
  • Submodules
  • houndapi.client.methods.poll module
    • Poll
      • Poll.poll()
  • houndapi.client.methods.subscribe module
    • Subscribe
      • Subscribe.subscribe()
  • houndapi.client.methods.unsubscribe module
    • Unsubscribe
      • Unsubscribe.unsubscribe()
  • Module contents
    • APIMethods

Submodules

houndapi.client.client module

class houndapi.client.client.HoundAPI(host: str = '127.0.0.1', port: int | None = None, protocol: Literal['http', 'https'] = 'http')

Bases: APIMethods

the API that wraps all of the methods

Parameters:

• host (str, optional) – the host/domain ex: myapi.net, 127.0.0.1, default=”127.0.0.1”

• port (int, optional) – the host port, default = None

• protocol (str, optional) – the host protocol, default = “http”

async close() → None

Close the aiohttp ClientSession

async delete(endpoint: str, body: Dict[str, Any] = None) → Dict[str, Any] | List[Dict[str, Any]]

async get(endpoint: str) → Dict[str, Any] | List[Dict[str, Any]]

async post(endpoint: str, body: Dict[str, Any] = None) → Dict[str, Any] | List[Dict[str, Any]]

Module contents