/py-glo-board

A python library to help interact with GitKraken Glo Boards API

Primary LanguagePythonMIT LicenseMIT

py-glo-board

A python library to help interact with GitKraken Glo Boards API


Supported Endpoints & Features

API Endpoints:

This package supports the following v1 Glo Boards API endpoints

Boards

  • Get Boards
  • Create Board
  • Get Boards by ID
  • Edit Board
  • Delete Board

Columns

  • Create column
  • Edit column
  • Delete column

Cards

  • Get Cards
  • Create Card
  • Create Cards batch
  • Get Card By ID
  • Edit Card
  • Delete Card
  • Get Cards By Column ID

Labels

  • Create Label
  • Edit Label
  • Delete Label

Attachments

  • Get Attachments
  • Create Attachment

Comments

  • Get Comments By Card ID
  • Create Comment
  • Edit Comment
  • Delete Comment

User

  • Get User

Requirements

Python 3.6 or higher

Installing

pip install py-glo-board

Example

from py_glo_boards_api import GloBoard, types

globoard = GloBoard('<YOUR_PAT_TOKEN_HERE>')

# List all boards available (Only gets the id and the name of the board)
globoard.get_boards()

# Or select the fields you need, with the options available in the Glo api
fields=['archived_columns', 'archived_date', 'columns', 'created_by', 'created_date', 'invited_members', 'labels', 'members', 'name']
boards = globoard.get_boards(fields, per_page=3)

# Get card
globoard.get_card('<BOARD_ID>', '<CARD_ID>').to_dict()

FAQ

Please refer to Git Kraken Documentation for any further reading.

License

The source code for py-glo-board is released under the MIT License.