Python module for writing scripts for project management platform Club House (clubhouse.io API wrapper)
Project description
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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file clubhouse_api-1.0.2.tar.gz
.
File metadata
- Download URL: clubhouse_api-1.0.2.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6909283b0c73816b7b2ef8ec9ca854a38f67d614385659ef22a29b9ed2f8fb1f |
|
MD5 | d39b9769de429397284d6c9fc1387593 |
|
BLAKE2b-256 | e71bff97f6bad6f3e590987f4b28199137f1f12c5e45b6dd81e2763a36a98c10 |