Skip to main content

The unofficial Python client library for the Clubhouse API.

Project description

python-clubhouse-lib PyPI Version Total Downloads

The unofficial Python client library for the Clubhouse API.

python-clubhouse-lib is a Python wrapper around the Clubhouse API. It leverages typed dicts to better provide utility to the programmer when dealing with Clubhouse data. This library only provides the basic glue between your application and Clubhouse, and it doesn’t attempt to do anything more than that.

Installation

pip install clubhouse-lib

or

git clone https://github.com/huntrar/python-clubhouse-lib
cd clubhouse_lib
python setup.py install

Examples

Initializing the client

import clubhouse_lib, os
cc = clubhouse_lib.ClubhouseClient(os.environ.get('CLUBHOUSE_API_TOKEN'))

Listing Projects

projects = cc.listProjects()

Listing Stories

stories = cc.listStories(projects[0]['id'])

Update Story

cc.updateStory(stories[0]['id'], name='Hello World!')

Contributing

This project contains tooling for easily importing documentation from the Clubhouse API and converting it into Python.

The API slurper allows you to convert snippets of documentation into JSON objects, which can then be digested by the API builder which will build the Python code.

We use Black for code formatting. Our flake8 linting configuration is included in the repository.

News

1.0.0

  • Publishing the unofficial Python client library for the Clubhouse API.

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

clubhouse-lib-1.0.0.tar.gz (23.8 kB view details)

Uploaded Source

File details

Details for the file clubhouse-lib-1.0.0.tar.gz.

File metadata

  • Download URL: clubhouse-lib-1.0.0.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for clubhouse-lib-1.0.0.tar.gz
Algorithm Hash digest
SHA256 fbae0b1907dfbcf0a23256d611189c5121a1f15e45b0cd8c717b941286a790b5
MD5 c6a890a9d200a164a9f679d55daaf5f8
BLAKE2b-256 af9c7291cea2dfe098885af5cc905544ad1e9e891663f9bac861f1caeec06e82

See more details on using hashes here.

Supported by

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