/py-clubhouse

📅 Unofficial Python client for Clubhouse.io

Primary LanguagePython

py-clubhouse

Build Status Actions Status

Python client for Clubhouse (started as a fork of clubhouse-client)

Installation

The package is available on pypi and can be installed like any other packages.

$ pip install py-clubhouse

Usage

Refer to Clubhouse API Docs for more information.

from py_clubhouse import Clubhouse

clubhouse = Clubhouse('your api key')

story = clubhouse.get_story(1234)  # returns Story object
workflows = clubhouse.workflows()  # returns list of Workflow objects
stories = clubhouse.search_stories("state:Staging")  # returns list of Story objects

Development

  1. Clone repo
  2. Install poetry globally.
  3. Activate virtual env poetry shell
  4. Install dependencies with poetry install
  5. Run pytest poetry run pytest

TODO

  • add GHA workflow
  • create models for relevant resources
  • moar tests
  • add c.r.u.d. methods for relevant models