Backlog API v2 Client Library
Project description
BacklogPy is Backlog API v2 Client Library for Python 2/3
Install
You can install the client library with pip:
$ pip install BacklogPy
Example
The client Library has API Call methods for All Backlog v2 API:
>>> from BacklogPy import Backlog
>>> backlog = Backlog('space_name','api-key')
>>> response = backlog.get_project_list(all=True, archived=True)
>>> print(response.json()[0])
{'archived': False,
'chartEnabled': True,
'displayOrder': 1234563786,
'id': 12345,
'name': 'Coffee Project',
'projectKey': 'COFFEE_PROJECT',
'projectLeaderCanEditProjectLeader': True,
'subtaskingEnabled': False,
'textFormattingRule': 'markdown',
'useWikiTreeView': True}
Also you can use dict parameters with ‘*_raw’ methods:
>>> response = backlog.get_project_list_raw({'archived':'false', 'all':'false'})
ScreenShot
You can use auto-completion for methods and arguments in Interpreter(IPython) and IDE(PyCharm, Jedi and more)
Development
Tests
tox can support to test with few python versions
$ tox
$ tox -e py26,py36
or nosetests for one Python version
$ nosetests tests/backlog
Generating The Backlog API v2 Client
The Backlog API v2 Client is created by api_generator. api_generator downloads API Documents from https://developer.nulab-inc.com/docs/backlog/ . And parse API Documents to generate The Backlog API v2 Client:
$ python3 api_generator/api_generator.py download
$ python3 api_generator/api_generator.py create
Build Wheel Package
$ pip3 install wheel
$ python3 setup.py bdist_wheel
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
Built Distribution
File details
Details for the file BacklogPy-1.1.0.tar.gz
.
File metadata
- Download URL: BacklogPy-1.1.0.tar.gz
- Upload date:
- Size: 153.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 673d230b8e1bf577ea65e56a4627350d5530c74d79fcc450766135c9960d0c44 |
|
MD5 | a1acafcf5d657cd42ed9771e3f5bc4d5 |
|
BLAKE2b-256 | 64e83dbe6860bad11dc73624b7a51a3c9cf541591edda875195219e3766f3d65 |
File details
Details for the file BacklogPy-1.1.0-py3-none-any.whl
.
File metadata
- Download URL: BacklogPy-1.1.0-py3-none-any.whl
- Upload date:
- Size: 27.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba59476d7b027aaa27071feceaed2e7ff49c010c9fbae87852290eda522d33c3 |
|
MD5 | bcb483d22c53208f08bb059aa52de72e |
|
BLAKE2b-256 | b734d88d5637fd04f97d6fd0eea2993efdb49eb4a4f092872bc915dfbf765a7b |