Skip to main content

Python client for Clubhouse

Project description

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

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

py-clubhouse-0.1.2.tar.gz (6.2 kB view hashes)

Uploaded Source

Built Distribution

py_clubhouse-0.1.2-py3-none-any.whl (10.5 kB view hashes)

Uploaded Python 3

Supported by

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