Skip to main content

Python module for writing scripts for project management platform Club House (clubhouse.io API wrapper)

Project description

fresh9

PyPI Python 3.6, 3.7, 3.8 GitHub Pull Requests License Forks

club_house_api - this module is a Python client library for The ClubHouse project management platform API (ClubHouse API wrapper)

Clubhouse is collaborative project management that streamlines and refines your existing workflow. The intuitive and powerful project management platform loved by software teams of all sizes. Clubhouse is here.

API documentation https://clubhouse.io/api/rest/v3/

Installation

Install the current version with PyPI:

pip install clubhouse_api

Or from Github:

pip install https://github.com/Peopl3s/club-house-api/archive/main.zip

Usage

You can generate a token for clubhouse by going to the account section and generating a new token

TOKEN = os.getenv('TOKEN')

club_house_session = ClubHouse(TOKEN, 'v3')
club_house = club_house_session.get_api()

Example

Create a new Story in the first Project that is returned from the API in the all projects list.

If you installed a module from PyPi, you should to import it like this: from clubhouse_api import ClubHouse

If from GitHub or source: from club_house_api import ClubHouse

from club_house_api import ClubHouse
import asyncio
import os

TOKEN = os.getenv('API_TOKEN')

club_house_session = ClubHouse(TOKEN, 'v3')
club_house = club_house_session.get_api()

async def main():

    all_projects = await club_house.projects()
    first_project_id = all_projects[0]['id']

    new_story = {'name': 'My new story', 'project_id': first_project_id}
    story = await club_house.stories.create(**new_story)
    print(story)

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

You can check out all the docs with examples here

Contributing

Bug reports and/or pull requests are welcome

License

The module is available as open source under the terms of the Apache License, Version 2.0

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

fresh9-0.0.3.tar.gz (10.7 kB view details)

Uploaded Source

File details

Details for the file fresh9-0.0.3.tar.gz.

File metadata

  • Download URL: fresh9-0.0.3.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for fresh9-0.0.3.tar.gz
Algorithm Hash digest
SHA256 d5d0b1b8cef87135c7ade38842fb3e8705cb3f6ce72cd2d22d6a5a0af05043fb
MD5 2dd8f1e46c9ab444b6323caccb1199e2
BLAKE2b-256 53469608d75ae27251118b5523a190a0b4825939c67032a95d1c9a6b32e7f158

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