https://github.com/nickatnight/py-clubhouse

📅 Unofficial Python client for Clubhouse.io
https://github.com/nickatnight/py-clubhouse

clubhouse clubhouse-api project-management python python3

Last synced: 12 days ago
JSON representation

📅 Unofficial Python client for Clubhouse.io

• Host: GitHub
• URL: https://github.com/nickatnight/py-clubhouse
• Owner: nickatnight
• Created: 2020-11-03T08:33:24.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-05T02:48:56.000Z (about 4 years ago)
• Last Synced: 2024-12-01T15:12:06.502Z (about 1 month ago)
• Topics: clubhouse, clubhouse-api, project-management, python, python3
• Language: Python
• Homepage: https://clubhouse.io/
• Size: 35.2 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# py-clubhouse







  







Python client for Clubhouse (started as a fork of [clubhouse-client](https://github.com/allardbrain/clubhouse-client))

## Installation

The package is available on [pypi](https://pypi.org/project/py-clubhouse/) and can be installed like any other packages.

    $ pip install py-clubhouse

## Usage

Refer to [Clubhouse API Docs](https://clubhouse.io/api/rest/v3/) for more information.

```python

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](https://github.com/python-poetry/poetry/blob/master/README.md) 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