https://github.com/dpeite/py-glo-board
A python library to help interact with GitKraken Glo Boards API
https://github.com/dpeite/py-glo-board
api api-rest gitkraken gitkraken-glo glo-board pypi-packages python python36
Last synced: 11 months ago
JSON representation
A python library to help interact with GitKraken Glo Boards API
- Host: GitHub
- URL: https://github.com/dpeite/py-glo-board
- Owner: dpeite
- License: mit
- Created: 2019-03-30T16:36:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-13T14:55:32.000Z (over 6 years ago)
- Last Synced: 2025-07-11T18:50:38.024Z (11 months ago)
- Topics: api, api-rest, gitkraken, gitkraken-glo, glo-board, pypi-packages, python, python36
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-glo-board
>A python library to help interact with GitKraken [Glo Boards API](https://support.gitkraken.com/developers/api/)
## Supported Endpoints & Features
**API Endpoints:**
>This package supports the following v1 [Glo Boards API endpoints](https://gloapi.gitkraken.com/v1/docs/)
**Boards**
- [x] Get Boards
- [x] Create Board
- [x] Get Boards by ID
- [x] Edit Board
- [x] Delete Board
**Columns**
- [x] Create column
- [x] Edit column
- [x] Delete column
**Cards**
- [x] Get Cards
- [x] Create Card
- [X] Create Cards batch
- [x] Get Card By ID
- [x] Edit Card
- [x] Delete Card
- [x] Get Cards By Column ID
**Labels**
- [x] Create Label
- [x] Edit Label
- [x] Delete Label
**Attachments**
- [X] Get Attachments
- [X] Create Attachment
**Comments**
- [x] Get Comments By Card ID
- [x] Create Comment
- [x] Edit Comment
- [x] Delete Comment
**User**
- [x] Get User
## Requirements
Python 3.6 or higher
## Installing
```bash
pip install py-glo-board
```
## Example
```python
from py_glo_boards_api import GloBoard, types
globoard = GloBoard('')
# 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('', '').to_dict()
```
## FAQ
Please refer to [Git Kraken Documentation](https://support.gitkraken.com/developers/overview/) for any
further reading.
## License
[MIT]: https://opensource.org/licenses/MIT
The source code for py-glo-board is released under the [MIT License][MIT].