Giter Site home page Giter Site logo

peopl3s / club-house-api Goto Github PK

View Code? Open in Web Editor NEW
7.0 2.0 5.0 71 KB

Python module for Club House project management platform (ClubHouse API wrapper)

Home Page: https://www.youtube.com/channel/UCru5FZQN_Xa0tKfrBqUIcng

License: Apache License 2.0

Python 100.00%
python api-wrapper clubhouse clubhouse-api async async-clubhouse-api python3

club-house-api's Introduction

club_house_api

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

club-house-api's People

Contributors

peopl3s avatar xm4dn355x avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.