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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file py-clubhouse-0.1.2.tar.gz.

File metadata

  • Download URL: py-clubhouse-0.1.2.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.7 Darwin/19.6.0

File hashes

Hashes for py-clubhouse-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5e4f8d777c554abdfbe5418ab60ae020bccde834d8d062d83f2e19ae3a225692
MD5 1b12ba77de71c5f69b3686b1ef93e1df
BLAKE2b-256 fca5ca1ac56560a74455a504be7aa83a2582c51d3a9c46deacc8595631b659ca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: py_clubhouse-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.7 Darwin/19.6.0

File hashes

Hashes for py_clubhouse-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0ede4044ee7404f802d2f0cce0fd2bd75902d583e1f21ce1bc3c60c296649182
MD5 51fb8e6cf1678afe8fd0258d738f0e07
BLAKE2b-256 4a4ab56a627d278dc1b59efac3609bfcda5b725af7406d02b318f371d4e7d2a4

See more details on using hashes here.

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