club_house_api

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

• Epics
• Files
• Labels
• Linked-Files
• Projects
• Story-Links
• Stories
  • Comments
  • Tasks
• Users
• Workflows

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